# divoom-cli
Command line tool built on top of divoom APIs for controlling divoom devices, like pixoo (and from how divoom's api/doc organizes, maybe more in the future).
[](LICENSE-APACHE)
[](https://riff.visualstudio.com/divoom/_build/latest?definitionId=7&branchName=main)
| Release | Status |
|:---:|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Crates.io | [](https://crates.io/crates/divoom-cli) | |
| Install | [](https://github.com/microsoft/winget-pkgs/tree/master/manifests/r/r12f/DivoomCli) [](https://snapcraft.io/divoom-cli) |
| Nuget
packages | [](https://www.nuget.org/packages/divoom-cli.windows.x86/) [](https://www.nuget.org/packages/divoom-cli.windows.x64/) [](https://www.nuget.org/packages/divoom-cli.windows.arm64/)
[](https://www.nuget.org/packages/divoom-cli.linux.x86/) [](https://www.nuget.org/packages/divoom-cli.linux.x64/) [](https://www.nuget.org/packages/divoom-cli.linux.arm/) [](https://www.nuget.org/packages/divoom-cli.linux.arm64/)
[](https://www.nuget.org/packages/divoom-cli.macos.x64/) |
```rust
# Check current channel
> divoom-cli 192.168.0.123 channel get
clock
# Set channel to clock with id 100
> divoom-cli 192.168.0.164 channel set-clock 100
# Get clock channel info
> divoom-cli 192.168.0.164 channel get-clock
---
clock-id: 100
brightness: 100
```
## How to install
### via Cargo
```bash
cargo install divoom-cli
```
### via winget
```powershell
winget install DivoomCli
```
### via scoop
Since we haven't reached the [criteria for Scoop Main bucket](https://github.com/ScoopInstaller/Scoop/wiki/Criteria-for-including-apps-in-the-main-bucket), we need to use our own bucket at this moment.
```powershell
# Add our scoop bucket for the first time.
scoop bucket add r12f https://github.com/r12f/scoop-bucket
# Install
scoop install divoom-cli
```
## How to use
It is straight forward to use the command line tool. Usually, we do it in 2 steps:
- Use device discovery API to find all devices in the LAN that we are in.
- Use device APIs to control the devices. No login/authentication is needed in the process.
### Discover devices in the same LAN
```bash
> divoom-cli discover
---
- device-name: Pixoo
device-id: 300000001
device-private-ip: 192.168.0.123
```
### Use Devices APIs to control the device
All device APIs are having the same format:
```bash
divoom-cli [parameters]
```
So we can run the commands like below:
```bash
# Check current channel
> divoom-cli 192.168.0.123 channel get
---
clock
# Check current clock
> divoom-cli 192.168.0.123 channel get-clock
---
clock_id: 100
brightness: 67
# Set channel to clock with id 100
> divoom-cli 192.168.0.164 channel set-clock 100
# Play a gif from Internet by calling the API provided by Divoom Device.
# Please note that: this API can be unstable and only accepts GIF with 16x16, 32x32 and 64x64 image size.
> divoom-cli 192.168.0.123 animation gif play --url https://www.gifandgif.eu/animated_gif/Planets/Animated%20Gif%20Planets%20(16).GIF
# To help playing GIF in a more stable way, we can use the image animation API to craft an animation and draw the GIF
# frames into it and send to device to play, e.g.:
> divoom-cli 192.168.0.123 animation image render-gif "logo-16-rotate-4-frames.gif" 16 -s 100
# Create the same GIF animation as above, but with size stretched, rotation 30 degrees and opacity 0.5.
> divoom-cli 192.168.0.123 animation image render-gif "logo-16-rotate-4-frames.gif" 32 -s 100 -f stretch -o 0.5 -r 30
# Create a text animation
# Please note that: this API only works after we use "animation image render-gif" API to draw anything. This API call will be ignored,
# when the device is showing other things, like clock or channel.
> divoom-cli 192.168.0.123 animation text set 1 "Hello world!"
> divoom-cli 192.168.0.123 animation text set 2 "The gray fox jumped over the lazy dog" -y 20
# Modify existing text animation. E.g. changing "Hello world!" above to "Hello Divoom!"
> divoom-cli 192.168.0.123 animation text set 1 "Hello Divoom!"
# Send a raw request
#
# NOTICE: the double quotes in json string passed into the program needs to escaped with '\',
# otherwise, rust runtime (not clap) will eat them before reaching main function, even we
# pass the whole string as a string.
> divoom-cli 192.168.0.164 raw '{\"Command\": \"Device/SetHighLightMode\", \"Mode\": 0}'
```
### Parameter/Output format
By default, divoom-cli uses yaml as output format with all field names in `kebab-case`. And beside yaml, we support json format too.
To specify the output format, we can use `-o` parameter:
```bash
> divoom-cli -o json 192.168.0.164 channel get-clock
{"clock-id":100,"brightness":67}
> divoom-cli -o yaml 192.168.0.164 channel get-clock
---
clock-id: 100
brightness: 67
```
For values, divoom-cli always expect `camelCase` to be used, both in parameter and output.
```bash
> divoom-cli 192.168.0.123 channel set customPage
> divoom-cli 192.168.0.123 channel get
---
customPage
```
### More help
We can find more info in the command help like below.
```bash
> divoom-cli
divoom-cli 0.0.1
r12f
https://github.com/r12f/divoom
USAGE:
divoom-cli.exe [OPTIONS] [device-address]
FLAGS:
-h, --help Prints help information
-V, --version Prints version information
OPTIONS:
-o, --output