mirror of
https://github.com/cccb/servicepoint.git
synced 2025-01-18 18:10:14 +01:00
64 lines
2.7 KiB
Markdown
64 lines
2.7 KiB
Markdown
|
# servicepoint_binding_c
|
||
|
|
|
||
|
|
[](https://crates.io/crates/servicepoint)
|
||
|
|
[](https://crates.io/crates/servicepoint)
|
||
|
|
[](https://docs.rs/servicepoint/latest/servicepoint/)
|
||
|
|
[](../../LICENSE)
|
||
|
|
|
||
|
|
In [CCCB](https://berlin.ccc.de/), there is a big pixel matrix hanging on the wall. It is called "Service Point
|
||
|
|
Display" or "Airport Display".
|
||
|
|
This crate contains C bindings for the `servicepoint` library, enabling users to parse, encode and send packets to this display via UDP.
|
||
|
|
|
||
|
|
## Examples
|
||
|
|
|
||
|
|
```c++
|
||
|
|
#include <stdio.h>
|
||
|
|
#include "servicepoint.h"
|
||
|
|
|
||
|
|
int main(void) {
|
||
|
|
sp2_Connection *connection = sp2_connection_open("localhost:2342");
|
||
|
|
if (connection == NULL)
|
||
|
|
return 1;
|
||
|
|
|
||
|
|
sp2_PixelGrid *pixels = sp2_pixel_grid_new(sp2_PIXEL_WIDTH, sp2_PIXEL_HEIGHT);
|
||
|
|
sp2_pixel_grid_fill(pixels, true);
|
||
|
|
|
||
|
|
sp2_Command *command = sp2_command_bitmap_linear_win(0, 0, pixels, Uncompressed);
|
||
|
|
sp2_Packet *packet = sp2_packet_from_command(command);
|
||
|
|
if (!sp2_connection_send(connection, packet))
|
||
|
|
return 1;
|
||
|
|
|
||
|
|
sp2_connection_dealloc(connection);
|
||
|
|
return 0;
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
A full example including Makefile is available as part of this crate.
|
||
|
|
|
||
|
|
## Note on stability
|
||
|
|
|
||
|
|
This library is still in early development.
|
||
|
|
You can absolutely use it, and it works, but expect minor breaking changes with every version bump.
|
||
|
|
Please specify the full version including patch in your Cargo.toml until 1.0 is released.
|
||
|
|
|
||
|
|
## Installation
|
||
|
|
|
||
|
|
Copy the header to your project and compile against.
|
||
|
|
|
||
|
|
You have the choice of linking statically (recommended) or dynamically.
|
||
|
|
- The C example shows how to link statically against the `staticlib` variant.
|
||
|
|
- When linked dynamically, you have to provide the `cdylib` at runtime in the _same_ version, as there are no API/ABI guarantees yet.
|
||
|
|
|
||
|
|
## Notes on differences to rust library
|
||
|
|
|
||
|
|
- function names are: `sp2_` \<struct_name\> \<rust name\>.
|
||
|
|
- Use the rust documentation.
|
||
|
|
- Instances get consumed in the same way they do when writing rust / C# code. Do not use an instance after an (implicit!) free.
|
||
|
|
- Option<T> or Result<T, E> turn into nullable return values - check for NULL!
|
||
|
|
- There are no specifics for C++ here yet. You might get a nicer header when generating directly for C++, but it should be usable.
|
||
|
|
- Reading and writing to instances concurrently is not safe. Only reading concurrently is safe.
|
||
|
|
|
||
|
|
## Everything else
|
||
|
|
|
||
|
|
Look at the main project [README](https://github.com/cccb/servicepoint/blob/main/README.md) for further information.
|