masrobo-rcs-sdk 0.2.2

A Python SDK for Masrobo RCS OPEN API

Open Python SDK

Open Python SDK is a lightweight Python client for the Boticz Open API.

Features

• X-Token authentication using JWT tokens generated from app_id and app_key using JWT tokens generated from app_id and app_key
• Unified HTTP client and error handling
• IoT device APIs
  • Get latest device data
  • Send device command
  • Add device
  • Bind device
  • Update device settings

如何使用

安装

pip3 install masrobo_rcs_sdk

Quick Start

from masrobo_rcs_sdk import RobotController, TopicDeviceData, GetLatestDeviceDataRequest

client = RobotController(
    base_url="https://api.boticz.cn/open",
    app_id="your-app-id",
    app_key="your-app-key",
)

resp = client.IotDevice.get_latest_device_data(
    GetLatestDeviceDataRequest(
        product_name="demo_product",
        device_id="device001",
        topic_name=TopicDeviceData,
    )
)

print(resp)

Available APIs

Get latest device data

from masrobo_rcs_sdk import TopicScreenshot, GetLatestDeviceDataRequest

client.IotDevice.get_latest_device_data(
    GetLatestDeviceDataRequest(
        product_name="demo_product",
        device_id="device001",
        topic_name=TopicScreenshot,
    )
)

Send device command

from masrobo_rcs_sdk import TopicRemoteControl, SendDeviceCommandRequest

client.IotDevice.send_device_command(
    SendDeviceCommandRequest(
        command="reboot",
        parameter='{"delay":1}',
        device_id="device001",
        product_name="demo_product",
        topic_name=TopicRemoteControl,
    )
)

Bind device

from masrobo_rcs_sdk import BindDeviceRequest

client.IotDevice.bind_device(BindDeviceRequest(device_id="device001"))

Add device

from masrobo_rcs_sdk import AddDeviceRequest

result = client.IotDevice.add_device(
    AddDeviceRequest(
        project_name="demo_product",
        device_id="device001",
    )
)
print(result.qrcode_url)

Update device settings

from masrobo_rcs_sdk import DeviceSettingRequest

client.IotDevice.setting(
    DeviceSettingRequest(
        device_id="device001",
        settings='{"temperature":{"max_value":30,"min_value":10,"calibration":0},"humidity":{"max_value":80,"min_value":20,"calibration":0},"data_recording_interval":5,"reporting_interval":10,"alert_interval":15,"alert_battery":10}',
    )
)

Error Handling

from masrobo_rcs_sdk import APIError

try:
    client.IotDevice.get_latest_device_data(
        GetLatestDeviceDataRequest(
            product_name="demo_product",
            device_id="device001",
            topic_name=TopicDeviceData,
        )
    )
except APIError as err:
    print(err.status_code, err.code, err.message)