python3客户端使用miris管理器远程控制
miris-manager-client的Python项目详细描述
Ubicast Miris Manager客户端
python3客户端使用ubicast miris管理器远程控制api。
此客户端旨在充当miris管理器中的一个系统,因此它允许您集成一个设备,以便使用miris管理器控制它。
重要
对于生产使用,建议使用名为“stable”的分支。“主”分支用于开发。
客户端类实例化
客户端类(mm_client
.client
.MirisManagerClient
)有两个参数:
local_conf
:这个参数可以是dict或path(str
对象)。默认值是None
,这意味着没有配置。setup_logging
:此参数必须是布尔值。如果设置为True
,将配置到控制台的日志记录。默认值是True
。
有关老客户的说明
如果您正在使用此客户端的第一个版本(commit33b554991303b573254d59fb757f601d1e84d132
和以前的commit),请执行以下步骤更新您的客户端:
- 使用setup.py安装新客户端。
- 替换
MirisManagerClient
的导入路径(请参见示例)。 - 用类实例参数
MirisManagerClient
.LOCAL_CONF
替换类变量MirisManagerClient
.local_conf
。 - 检查
MirisManagerClient
.DEFAULT_CONF
的值,因为它现在默认为None
。 - 用所有配置中的
SERVER_URL
替换所有出现的URL
。 - 用所有配置中的
VERIFY_SSL
替换所有出现的CHECK_SSL
。
示例
ping服务器
frommm_client.clientimportMirisManagerClientmmc=MirisManagerClient(local_conf='your-conf.json')response=mmc.api_request('PING')print(response)
在examples
目录中有更多的示例。
操作
以下是根据支持的功能可以发送到客户端的操作列表:
# Basic actions
SHUTDOWN: capability: shutdown, description: Shutdown system
REBOOT: capability: reboot, description: Reboot system
UPGRADE: capability: upgrade, description: Upgrade system software
# Recording
START_RECORDING: capability: record, description: Start recording
STOP_RECORDING: capability: record, description: Stop recording
LIST_PROFILES: capability: record, description: Refresh profiles list
# Publishing
START_PUBLISHING: capability: publish, description: Start publishing non published media
STOP_PUBLISHING: capability: publish, description: Stop publishing
# Wake on lan
WAKE_ON_LAN_SEND: capability: send_wake_on_lan, description: Send a wake on LAN network package from this system to wake another system