servicepoint/servicepoint
1
1
Fork 0
Code Issues Pull requests 1 Actions Packages Projects Releases 6 Wiki Activity

update README
Some checks failed
Rust / build (pull_request) Failing after 1m30s
Details

Browse source
This commit is contained in:
Vinzenz Schroeter 2025-05-03 09:46:46 +02:00
parent 4e1433b54c
commit 2081ed3e06
1 changed files with 41 additions and 27 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

62
README.md
View file

@ -24,11 +24,13 @@ use std::net::UdpSocket;
use servicepoint::*; use servicepoint::*;
fn main() { fn main() {
// establish connection // this should be the IP of the real display @CCCB
let connection = UdpSocket::bind("172.23.42.29:2342") let destination = "172.23.42.29:2342";
.expect("connection failed");
// clear screen content // establish connection
let connection = UdpSocket::bind(destination).expect("connection failed");
// clear screen content using the UdpSocketExt
connection.send_command(ClearCommand).expect("send failed"); connection.send_command(ClearCommand).expect("send failed");
} }
``` ```
@ -46,7 +48,7 @@ or
```toml ```toml
[dependencies] [dependencies]
servicepoint = "0.13.2" servicepoint = "0.14.0"
``` ```
## Note on stability ## Note on stability
@ -63,22 +65,28 @@ All of this means for you: please specify the full version including patch in yo
Release notes are published [here](https://git.berlin.ccc.de/servicepoint/servicepoint/releases), please check them before updating. Release notes are published [here](https://git.berlin.ccc.de/servicepoint/servicepoint/releases), please check them before updating.
Currently, this crate requires Rust [v1.70](https://releases.rs/docs/1.70.0/) from June 2023.
## Features ## Features
This library has multiple optional dependencies. This library has multiple optional dependencies.
You can choose to (not) include them by toggling the related features. You can choose to (not) include them by toggling the related features.
| Name | Default | Description | Dependencies | | Name | Default | Description | Dependencies |
|--------------------|---------|----------------------------------------------|-----------------------------------------------------| |-------------------|---------|----------------------------------------------|-------------------------------------------------|
| protocol_udp | true | `Connection::Udp` | |
| cp437 | true | Conversion to and from CP-437 | [once_cell](https://crates.io/crates/once_cell) | | cp437 | true | Conversion to and from CP-437 | [once_cell](https://crates.io/crates/once_cell) |
| compression_lzma | true | Enable additional compression algo | [rust-lzma](https://crates.io/crates/rust-lzma) | | compression_lzma | true | Enable additional compression algorithm | [rust-lzma](https://crates.io/crates/rust-lzma) |
| compression_zlib | false | Enable additional compression algo | [flate2](https://crates.io/crates/flate2) | | compression_zlib | false | Enable additional compression algorithm | [flate2](https://crates.io/crates/flate2) |
| compression_bzip2 | false | Enable additional compression algo | [bzip2](https://crates.io/crates/bzip2) | | compression_bzip2 | false | Enable additional compression algorithm | [bzip2](https://crates.io/crates/bzip2) |
| compression_zstd | false | Enable additional compression algo | [zstd](https://crates.io/crates/zstd) | | compression_zstd | false | Enable additional compression algorithm | [zstd](https://crates.io/crates/zstd) |
| protocol_websocket | false | `Connection::WebSocket` | [tungstenite](https://crates.io/crates/tungstenite) |
| rand | false | `impl Distribution<Brightness> for Standard` | [rand](https://crates.io/crates/rand) | | rand | false | `impl Distribution<Brightness> for Standard` | [rand](https://crates.io/crates/rand) |
Es an example, if you only want zlib compression:
```
[dependencies]
servicepoint = { version = "0.14.0", default-features = false, features = ["compression_zlib"] }
```
If you are looking at features to minimize binary size: take a look at the `tiny_announce`-example! If you are looking at features to minimize binary size: take a look at the `tiny_announce`-example!
## Supported language bindings ## Supported language bindings
@ -95,17 +103,14 @@ If you are looking at features to minimize binary size: take a look at the `tiny
## Projects using the library ## Projects using the library
- screen simulator (rust): [servicepoint-simulator](https://git.berlin.ccc.de/servicepoint/servicepoint-simulator) - [servicepoint-simulator](https://git.berlin.ccc.de/servicepoint/servicepoint-simulator): a screen simulator written in rust
- A bunch of projects (C): [arfst23/ServicePoint](https://github.com/arfst23/ServicePoint), including - [servicepoint-tanks](https://git.berlin.ccc.de/vinzenz/servicepoint-tanks): a multiplayer game written in C# with a second screen in the browser written in React/Typescript
- a CLI tool to display image files on the display or use the display as a TTY - [servicepoint-life](https://git.berlin.ccc.de/vinzenz/servicepoint-life): a cellular automata slideshow written in rust
- a BSD games robots clone - [servicepoint-cli](https://git.berlin.ccc.de/servicepoint/servicepoint-cli): a CLI that can:
- a split-flap-display simulator - share (stream) your screen
- animations that play on the display - send image files with dithering
- tanks game (C#): [servicepoint-tanks](https://github.com/kaesaecracker/cccb-tanks-cs) - clear the display
- cellular automata slideshow (rust): [servicepoint-life](https://github.com/kaesaecracker/servicepoint-life) - ...
- partial typescript implementation inspired by this library and browser
stream: [cccb-servicepoint-browser](https://github.com/SamuelScheit/cccb-servicepoint-browser)
- a CLI, can also share your screen: [servicepoint-cli](https://git.berlin.ccc.de/servicepoint/servicepoint-cli)
To add yourself to the list, open a pull request. To add yourself to the list, open a pull request.
@ -114,9 +119,18 @@ bigger collection of projects, including some not related to this library.
If you have access, there is even more software linked in [the wiki](https://wiki.berlin.ccc.de/LED-Riesendisplay). If you have access, there is even more software linked in [the wiki](https://wiki.berlin.ccc.de/LED-Riesendisplay).
Some more related projects:
- [cccb-servicepoint-browser](https://github.com/SamuelScheit/cccb-servicepoint-browser): a partial typescript implementation inspired by this library and browser stream
- [arfst23/ServicePoint](https://github.com/arfst23/ServicePoint): a bunch of projects in C that [used to](https://zerforschen.plus/posts/tiny-binaries-rust/) use the C bindings
- a CLI tool to display image files on the display or use the display as a TTY
- a BSD games robots clone
- a split-flap-display simulator
- animations that play on the display
## Contributing ## Contributing
See [CONTRIBUTING.md](CONTRIBUTING.md). You are welcome to contribute, see [CONTRIBUTING.md](CONTRIBUTING.md).
## What happened to servicepoint2? ## What happened to servicepoint2?