Struct divoom::DivoomServiceClient

pub struct DivoomServiceClient { /* private fields */ }

Divoom backend service client

This is the client that talks to Divoom online service for fetching information like device info in the same LAN etc.

It is very simple to start using it, simply creates the client without argument, and then start calling the APIs:

use divoom::*;
let divoom = DivoomServiceClient::new();
// let devices = divoom.get_same_lan_devices().await?;
// devices.iter().for_each(|x| println!("{:?}", x));

Implementations

impl DivoomServiceClient

pub fn new() -> DivoomServiceClient

Create new DivoomServiceClient

pub fn with_options(timeout: Option<Duration>) -> DivoomServiceClient

Create new DivoomServiceClient with options

pub fn with_server_url_base(
    server_url_base: String,
    timeout: Option<Duration>
) -> DivoomServiceClient

Create new DivoomServiceClient with specific server URL

pub fn server_url_base(&self) -> &str

Get the server url we send request to

pub async fn get_same_lan_devices(
    &self
) -> DivoomAPIResult<Vec<DivoomDeviceInfo>>

Find device

Official doc: http://doc.divoom-gz.com/web/#/12?page_id=336

Sample response:

{
    "ReturnCode": 0,
    "ReturnMessage": "",
    "DeviceList": [
        {
            "DeviceName": "Pixoo64",
            "DeviceId": 300000020,
            "DevicePrivateIP": "10.0.0.100"
        },
        ...
    ]
}

pub async fn get_clock_type(&self) -> DivoomAPIResult<Vec<String>>

Get channel type

Official doc: http://doc.divoom-gz.com/web/#/12?page_id=189

Sample response:

{
    "ReturnCode": 0,
    "ReturnMessage": "",
    "DialTypeList": [
        "Social",
        "normal",
        "financial",
        "Game",
        "HOLIDAYS",
        "TOOLS",
        "DESIGN-64"
    ]
}

pub async fn get_clock_list(
    &self,
    dial_type: String,
    page_index: i32
) -> DivoomAPIResult<DivoomClockInfoPage>

Get clock list

Official doc: http://doc.divoom-gz.com/web/#/12?page_id=190

Sample request:

{
    "DialType":"Social",
    "Page":1
}

Sample response:

{
    "ReturnCode": 0,
    "ReturnMessage": "",
    "TotalNum": 100,
    "DialList": [
        {
            "ClockId": 10,
            "Name": "Classic Digital Clock"
        },
        ...
    ]
}

pub async fn get_font_list(&self) -> DivoomAPIResult<Vec<DivoomFontInfo>>

Get time channel font list.

Official doc: http://doc.divoom-gz.com/web/#/12?page_id=233

Sample response:

{
    "ReturnCode": 0,
    "ReturnMessage": "",
    "FontList": [
        {
            "id": 2,
            "name": "8*8 English letters, Arabic figures,punctuation",
            "width": "8",
            "high": "8",
            "charset": "",
            "type": 0
        },
        ...
    ]
}

Trait Implementations

impl Default for DivoomServiceClient

fn default() -> Self

Returns the “default value” for a type.