A Python3 client to use Miris Manager remote control
UbiCast Miris Manager client
A Python3 client to use UbiCast Miris Manager remote control API.
This client is intended to act as a system in Miris Manager so it allows you to integrate a device in order to control it using Miris Manager.
For production use, it is recommended to use the branch named "stable". The "master" branch is used for development.
Client class instantiation
The client class (
MirisManagerClient) takes two arguments:
local_conf: This argument can be either a dict or a path (
strobject). The default value is
None, which means no configuration.
setup_logging: This argument must be a boolean. If set to
True, the logging to console will be configured. The default value is
Notes about older client
If you are using the first version of this client (commit
33b554991303b573254d59fb757f601d1e84d132 and previous commits), here are the steps to update your client:
- Install the new client using the setup.py.
- Replace the import path of
- Replace the class variable
LOCAL_CONFwith the class instance argument
- Check the value of
DEFAULT_CONFbecause it is now
- Replace all occurences of
SERVER_URLin all configuration.
- Replace all occurences of
VERIFY_SSLin all configuration.
Ping the server
from mm_client.client import MirisManagerClient mmc = MirisManagerClient(local_conf='your-conf.json') response = mmc.api_request('PING') print(response)
There are more examples in the
Here is the list of actions that can be sent to the client depending on its supported capabilities:
# 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
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|Filename, size||File type||Python version||Upload date||Hashes|
|Filename, size miris_manager_client-5.0-py2.py3-none-any.whl (17.0 kB)||File type Wheel||Python version py2.py3||Upload date||Hashes View hashes|
|Filename, size miris-manager-client-5.0.tar.gz (13.0 kB)||File type Source||Python version None||Upload date||Hashes View hashes|
Hashes for miris_manager_client-5.0-py2.py3-none-any.whl