Rust Library for controlling divoom devices that support REST APIs, such as pixoo-64 (and from how divoom's api/doc organizes, maybe more in the future).
```rust // Get current channel use divoom::*;
println!( "{}", PixooClient::new("192.168.0.123").getcurrentchannel().await? );
// Output: clock ```
Besides the SDK, a few more tools are provided to help people enjoy the device as well as serving as demo!
- A command line tool divoom-cli for controlling the device: https://github.com/r12f/divoom/tree/main/divoom_cli.
```bash
# Check current channel
divoom-cli 192.168.0.123 channel get
clock ```
divoom-gateway with Swagger UI and OpenAPI spec json provided, so we can control the device, build cron-like schedule, render customized animation and play it on the device: https://github.com/r12f/divoom/tree/main/divoom_gateway.To use this library, please add the following into the dependencies in the Cargo.toml file:
toml
[dependencies]
divoom = "0.1"
The library contains 2 major parts:
To discover all devices in your LAN, we can use the get_same_lan_devices API to get all devices from Divoom's backend service.
```rust use divoom::*;
let divoom = DivoomServiceClient::new(); let devices = divoom.getsamelandevices().await?; devices.iter().foreach(|x| println!("{:?}", x)); ```
This will output:
text
DivoomDeviceInfo { device_name: "Pixoo", device_id: 300000001, device_private_ip: "192.168.0.123" }
Once we get the Device Address, we can use it to create a pixoo client and start talking to it:
```rust use divoom::*;
let pixoo = PixooClient::new("192.168.0.123"); let result = pixoo.getcurrentchannel().await?; println!("{:?}", result); ```
This will output:
text
Clock
Currently, we have these APIs supported:
Devices like Pixoo-64 supports play GIF file from file or even Internet directly, all we need is to specify a URL as below:
```rust use divoom::*;
let pixoo = PixooClient::new("192.168.0.123");
pixoo.playgiffile(DivoomFileAnimationSourceType::Url, "
However, this device API is not quite stable (by 07/2022) and the most reliable way to play a GIF is to create an animation and draw all the GIF frames into it one by one. To help with this process, we created a resource loader and an animation builder to help.
```rust use divoom::*;
// Load the resource. let frames = DivoomAnimationResourceLoader::giffile("testdata/animationbuildertests/logo-16-rotate-4-frames.gif").unwrap();
// Build animation with 16 pixel canvas and 100ms frame play speed. let builder = DivoomAnimationBuilder::new(16, Duration::frommillis(100)).unwrap(); let animation = builder.drawframes(&frames, 0).build();
// Send to device here. let pixoo = PixooClient::new("192.168.0.123"); pixoo.sendimageanimation(animation).await ```
Or even simpler:
rust
use divoom::*;
let pixoo = PixooClient::new("192.168.0.123");
pixoo.render_gif_as_animation(16, Duration::from_millis(100), "test_data/animation_builder_tests/logo-16-rotate-4-frames.gif").await
Besides gif, we also support png and jpeg format. And besides reading from file, we also support loading resource from any Read trait. For more on how to use it, feel free to check our doc here: https://docs.rs/divoom/latest/divoom/struct.DivoomAnimationBuilder.html.
And for any reason, if you don't want the builtin animation builder, we can exclude it by specifying the features with:
toml
[dependencies]
divoom = { version = "0.1", features = [] }
To create a text animation, we can use DivoomTextAnimation structure and send_text_animation API to help us:
```rust use divoom::*;
let pixoo = PixooClient::new("192.168.0.123"); let animation = DivoomTextAnimation::default(); animation.textstring = "Foo".tostring(); pixoo.sendtextanimation(animation).await?; ```
In certain cases, we might want to run a lot of commands at the same time, such as initialize the settings. Pixoo devices supports batching all commands into a single request, but with only 1 single result being returned for indicating if everything succeeded or not.
Here is an example that we batch executed multiple commands to update the device settings:
rust
use divoom::*;
let pixoo = PixooClient::new("192.168.0.123");
pixoo.start_batch()
.set_device_rotation_angle(DivoomDeviceRotationAngle::Rotate90)
.set_device_mirror_mode(DivoomDeviceMirrorMode::On)
.set_device_brightness(30)
.execute().await.expect("Request should succeed.");
In case new API is released and we haven't support it yet, or we need to do some experimental things by sending the raw payload, we can use the following API to send raw request directly, which works for both single request and batch mode.
Single request mode:
```rust use divoom::*;
let pixoo = PixooClient::new("192.168.0.123"); pixoo.sendrawrequest("{ \"Command\": \"Device/SetHighLightMode\", \"Mode\": 0 }").await?.expect("Request should succeed."); ```
Batch mode:
rust
use divoom::*;
let pixoo = PixooClient::new("192.168.0.123");
pixoo.start_batch()
.send_raw_request("{ \"Command\": \"Device/SetHighLightMode\", \"Mode\": 0 }".into())
.execute_with_raw_response().await.expect("Request should succeed.");
The debug logs are logged at debug level. Once we set the log level to debug, we will be able to start see it:
rust
env_logger::Builder::from_env(env_logger::Env::default().default_filter_or("debug")).init();
Or we can use RUST_LOG environment variable to change the level and enable the logs:
With the command tool (covered below soon), on windows:
```powershell
$env:RUST_LOG="debug"; .\divoom-cli.exe 192.168.0.123 channel get ```
And on linux:
bash
RUST_LOG=debug ./divoom-cli.exe 192.168.0.123 channel get
Then we will see the output log like below:
```text [2022-07-10T00:33:50Z DEBUG divoom::clients::common::divoomrestclient] Sending request: Url = "http://192.168.0.123/post", Body = "{"Command":"Channel/GetIndex"}" [2022-07-10T00:33:50Z DEBUG reqwest::connect] starting new connection: http://192.168.0.123/ [2022-07-10T00:33:50Z DEBUG hyper::client::connect::http] connecting to 192.168.0.123:80 [2022-07-10T00:33:50Z DEBUG hyper::client::connect::http] connected to 192.168.0.123:80 [2022-07-10T00:33:50Z DEBUG hyper::proto::h1::io] flushed 107 bytes [2022-07-10T00:33:50Z DEBUG hyper::proto::h1::io] parsed 2 headers [2022-07-10T00:33:50Z DEBUG hyper::proto::h1::conn] incoming body is chunked encoding [2022-07-10T00:33:50Z DEBUG hyper::proto::h1::decode] incoming chunked header: 0x22 (34 bytes) [2022-07-10T00:33:50Z DEBUG reqwest::asyncimpl::client] response '200 OK' for http://192.168.0.123/post [2022-07-10T00:33:50Z DEBUG divoom::clients::common::divoomrest_client] Response header received: StatusCode = 200 [2022-07-10T00:33:50Z DEBUG hyper::proto::h1::conn] incoming body completed [2022-07-10T00:33:50Z DEBUG hyper::client::pool] pooling idle connection for ("http", 192.168.0.123)
customPage ```
To revert it back: ```powershell
customPage ```
Apache-2.0: https://www.apache.org/licenses/LICENSE-2.0