servicepoint/crates/servicepoint
2024-11-12 19:43:32 +01:00
..
examples replace Connection::send_mut with internal mutability 2024-11-12 19:34:50 +01:00
src fix missing doc warning 2024-11-12 19:43:32 +01:00
Cargo.toml err returns for series methods 2024-11-12 19:37:21 +01:00
README.md fix CI fails because example does not panic depending on network 2024-11-10 11:10:40 +01:00

servicepoint

crates.io Crates.io Total Downloads docs.rs GPLv3 licensed

In CCCB, there is a big pixel matrix hanging on the wall. It is called "Service Point Display" or "Airport Display". This crate contains a library for parsing, encoding and sending packets to this display via UDP.

Installation

cargo add servicepoint

or

[dependencies]
servicepoint = "0.10.0"

Examples

fn main() {
    // establish connection
    let connection = servicepoint::Connection::open("172.23.42.29:2342")
        .expect("connection failed");

    // clear screen content
    connection.send(servicepoint::Command::Clear)
        .expect("send failed");
}

More examples are available in the crate. Execute cargo run --example for a list of available examples and cargo run --example <name> to run one.

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.

Features

This library has multiple optional dependencies. You can choose to (not) include them by toggling the related features.

Name Default Description
compression_zlib false Enable additional compression algo
compression_bzip2 false Enable additional compression algo
compression_lzma true Enable additional compression algo
compression_zstd false Enable additional compression algo
protocol_udp true Connection::Udp
protocol_websocket false Connection::WebSocket
rand false impl Distribution for Standard
cp437 true Conversion to and from CP-437

Everything else

Look at the main project README for further information.