A Python3 client to use Miris Manager remote control
Project description
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.
Important
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 (mm_client
.client
.MirisManagerClient
) takes two arguments:
local_conf
: This argument can be either a dict or a path (str
object). The default value isNone
, which means no configuration.setup_logging
: This argument must be a boolean. If set toTrue
, the logging to console will be configured. The default value isTrue
.
Configuration
You can see available parameters in the default configuration file : Default configuration
The local configuration should be a json file.
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
MirisManagerClient
(see example). - Replace the class variable
MirisManagerClient
.LOCAL_CONF
with the class instance argumentMirisManagerClient
.local_conf
. - Check the value of
MirisManagerClient
.DEFAULT_CONF
because it is nowNone
by default. - Replace all occurences of
URL
bySERVER_URL
in all configuration. - Replace all occurences of
CHECK_SSL
byVERIFY_SSL
in all configuration.
Example
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 examples
directory.
Actions
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
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file miris-manager-client-5.4.tar.gz
.
File metadata
- Download URL: miris-manager-client-5.4.tar.gz
- Upload date:
- Size: 15.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.9.2
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 04c4dddc42464f5871df6020bf50c95c2ce8a41c3004fbbd5a018b4a87213a01 |
|
MD5 | 368459c691db5c70dde0c1ec97a20f2a |
|
BLAKE2b-256 | addf94abfdcdd5e75579432edb219b37b020ff1325d2ba19f719571831b66a38 |
File details
Details for the file miris_manager_client-5.4-py2.py3-none-any.whl
.
File metadata
- Download URL: miris_manager_client-5.4-py2.py3-none-any.whl
- Upload date:
- Size: 17.8 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.9.2
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 808609eb6d09036cc87d6893fe3cdd5d5cc5e7966b7d14fc191c4ed3fd224cdb |
|
MD5 | e0569527b8af8ac1eee95099929af93c |
|
BLAKE2b-256 | 55271cf82b5c57e4fc909c5fb749dc8142e684c3df75f8783e652f083ffabc07 |