This software may contain bugs that could affect system stability. Please use it at your own risk!
Integration for Unfolded Circle Remote Devices running Unfolded OS (currently Remote Two and the upcoming Remote 3) to send http requests, wake-on-lan magic packets and text over TCP.
Using uc-integration-api, requests, pywakeonlan and getmac.
- Supported entity features
- Planned features
- Configuration
- Usage
- Installation
- Build
- Versioning
- Changelog
- Contributions
- License
- Send http get, post, patch, put, delete & head requests to a specified url
- Add additional command parameters
- Option to ignore HTTP requests errors and always return a OK/200 status code to the remote
- Helpful if the server doesn't send any response or closes the connection after a command is received (fire and forget). The error message will still be logged but at debug instead of error level
- Send wake-on-lan magic packets to one or more mac addresses, ips (v4/v6) or hostnames (ipv4 only)
- Supported parameters
- Discover the mac address from an ip address or a hostname
- Not supported when running the integration on the remote due to sandbox limitations and may not work on all systems. Please refer to the getmac supported platforms
- Send text over TCP
- This method can be used with some home automation systems, tools like win-remote-control or for protocols like PJLink (used by a lot of projector brands like JVC, Epson or Optoma)
- Support for c++ and hex style control characters (e.g. new line, carriage return, tabulator etc.)
- The default timeout can be changed in the advanced setup settings
- SSH client entity
Additional smaller planned improvements or changes are labeled with #TODO in the code
During the integration setup you can turn on the advanced settings to change various timeouts and others entity related settings (see Usage). You can run the setup process again in the integration settings to change these settings after adding entities to the remote.
For http requests it's also possible to temporally overwrite one or more settings for a specific command by adding additional command parameters.
The integration exposes a media player entity for each supported command. These entities only support the source feature. Just enter the needed string needed for the chosen entity in the source field when you configure your activity/macro sequences or activity ui.
Enter the desired hostname, mac or ip address (ipv4/v6) in the source field when you configure your activity/macro sequence or activity ui. Multiple addresses can be separated by a comma.
Note: When running as a custom integration on the remote itself only mac addresses are supported.
All parameters from pywakeonlan are supported (interface=, port=, ip_address=)
Enter the desired url (including http(s)://) in the source field when you configure your activity/macro sequences or activity ui. Additional parameters can be added (see below).
Your server needs to respond with a 200 OK status or any other informational or redirection http status code (100s, 200s or 300s). If the server's response content is not empty it will be shown in the integration log. In case of a client or server error (400s or 500s) the command will fail on the remote and the error message and status code will be shown in the integration log.
If you activate the fire and forget mode the remote will always receive a 200 OK status code (see below).
Almost all parameters from the Python requests module like timeout, verify, data, json or headers are supported (see Python requests module parameters) although not all of them have been tested with this integration. Simply separate them with a comma.
When using one or more parameters you need to use the url parameter for the url itself as well. If a parameter value contains commas, equal signs or quotes put it in double quotes and use single quotes inside (see examples below).
When using a self signed ssl certificate you can globally deactivate ssl cert verification in the advanced setup or temporally for specific commands by using verify=False as a command parameter.
If you activate the option to ignore HTTP requests errors in the integration setup or by adding ffg=True as a command parameter a OK/200 status code will always be returned to the remote (fire and forget). This can be helpful if the requested server/device needs longer than the set timeout to wake up from deep sleep, generally doesn't send any response at all or closes the connection after a command is received. The error message will still be logged but at debug instead of error level.
| Use Case | Parameters | Example |
|---|---|---|
| Temporally use a different timeout and activate fire and forget mode | timeout and ffg |
url="https://httpbin.org/get", timeout=5, ffg=True |
| Adding form payload data` | data |
url="https://httpbin.org/post", data="key1=value1,key2=value2" |
| Adding json payload data (content type is set automatically) | json |
url="https://httpbin.org/post", json="{'key1':'value1','key2':'value2'}" |
| Adding xml payload data | data and headers |
url="https://httpbin.org/post", data="<Tests Id='01'><Test TestId='01'><Name>Command name</Name></Test></Tests>", headers="{'Content-Type':'application/xml'}" |
Legacy syntax
Optional payload data can be added to the request body with a specific separator character:
| Content type | Separator | Example | Notes |
|---|---|---|---|
application/x-www-form-urlencoded |
§ (paragraph) |
https://httpbin.org/post§key1=value1,key2=value2 |
Multiple values for a single key are currently not supported. |
application/json |
| (pipe) |
https://httpbin.org/post|{"key1":"value1","key2":"value2"} |
|
application/xml |
^ (caret) |
https://httpbin.org/post^<Tests Id="01"><Test TestId="01"><Name>Command name</Name></Test></Tests> |
If your actual url contains one or more of the above separators or other special characters that are not url reserved control characters you need to url-encode them first (e.g. with https://www.urlencoder.io)
This method can be used with some home automation systems, tools like win-remote-control or for certain protocols like PJLink (used by a lot of projector brands like JVC, Epson or Optoma)
- Generic Example: 192.168.1.1:1234, "Hello World"
- PJLink Power On Example: 192.168.1.1:4352,"%1POWR 1\r"
- Other PJLink commands can be found in the PJLink command descriptions (from page 17)
C++ and hex style control characters are supported to e.g. add a new line (\n or 0x0A), tab (\t or 0x09) or a carriage return (\r or 0x0D)
- C++ style characters can be escaped with a single additional backslash (e.g. \\n)
- Hex style characters can be escaped with "0\\\" (e.g. 0\\\0x09)
- The configuration file of custom integrations are not included in backups.
- You currently can't update custom integrations. You need to delete the integration from the integrations menu first and then re-upload the new version. Do not edit any activity or macros that includes entities from this integration after you removed the integration and wait until the new version has been uploaded and installed. You also need to add re-add entities to the main pages after the update as they are automatically removed. An update function will probably be added once the custom integrations feature will be available in stable firmware releases.
Download the uc-intg-requests-x.x.x-aarch64.tar.gz archive in the assets section from the latest release
Since firmware version 2.2.0 you can upload custom integrations in the web configurator. Go to integrations, click on install custom and choose the downloaded tar.gz file
curl --location 'http://$IP/api/intg/install' \
--user 'web-configurator:$PIN' \
--form 'file=@"uc-intg-sonysdcp-$VERSION-aarch64.tar.gz"'There is also a Core API GUI available at https://Remote-IP/doc/core-rest. Click on Authorize to log in (username: web-configurator, password: your PIN), scroll down to POST intg/install, click on Try it out, choose a file and then click on Execute.
Alternatively you can also use the inofficial UC Remote Toolkit
- Python 3.11
- Install Libraries:
(using a virtual environment is highly recommended)
pip3 install -r requirements.txtpython3 intg-requests/driver.pyFor the mDNS advertisement to work correctly it's advised to start the integration in the host network (--net=host). You can also set the websocket listening port with the environment variable UC_INTEGRATION_HTTP_PORT, set the listening interface with UC_INTEGRATION_INTERFACE or change the default debug log level with UC_LOG_LEVEL. See available environment variables
in the Python integration library.
All data is mounted to /usr/src/app:
docker run --net=host -n 'ucr2-integration-requests' -v './ucr2-integration-requests':'/usr/src/app/':'rw' 'python:3.11' /usr/src/app/docker-entry.shInstead of downloading the integration driver archive from the release assets you can also build and create the needed distribution binary and tar.gz archive yourself.
For Python based integrations Unfolded Circle recommends to use pyinstaller to create a distribution binary that has everything in it, including the Python runtime and all required modules and native libraries.
First we need to compile the driver on the target architecture because pyinstaller does not support cross compilation.
The --onefile option to create a one-file bundled executable should be avoided:
- Higher startup cost, since the wrapper binary must first extract the archive.
- Files are extracted to the /tmp directory on the device, which is an in-memory filesystem.
This will further reduce the available memory for the integration drivers!
We use the --onedir option instead.
On x86-64 Linux we need Qemu to emulate the aarch64 target platform:
sudo apt install qemu binfmt-support qemu-user-static
docker run --rm --privileged multiarch/qemu-user-static --reset -p yesRun pyinstaller:
docker run --rm --name builder \
--platform=aarch64 \
--user=$(id -u):$(id -g) \
-v "$PWD":/workspace \
docker.io/unfoldedcircle/r2-pyinstaller:3.11.6-0.2.0 \
bash -c \
"cd /workspace && \
python -m pip install -r requirements.txt && \
pyinstaller --clean --onedir --name int-requests intg-requests/driver.py"On an aarch64 host platform, the build image can be run directly (and much faster):
docker run --rm --name builder \
--user=$(id -u):$(id -g) \
-v "$PWD":/workspace \
docker.io/unfoldedcircle/r2-pyinstaller:3.11.6-0.2.0 \
bash -c \
"cd /workspace && \
python -m pip install -r requirements.txt && \
pyinstaller --clean --onedir --name intg-requests intg-requests/driver.py"Now we need to create the tar.gz archive that can be installed on the remote and contains the driver.json metadata file and the driver distribution binary inside the bin directory
mkdir -p artifacts/bin
mv dist/intg-requests/* artifacts/bin
mv artifacts/bin/intg-requests artifacts/bin/driver
cp driver.json artifacts/
tar czvf uc-intg-requests-aarch64.tar.gz -C artifacts .
rm -r dist build artifacts intg-requests.specI use SemVer for versioning. For the versions available, see the tags and releases in this repository.
The major changes found in each new release are listed in the changelog and under the GitHub releases.
Contributions to add new feature, implement #TODOs from the code or improve the code quality and stability are welcome! First check whether there are other branches in this repository that maybe already include your feature. If not, please fork this repository first and then create a pull request to merge your commits and explain what you want to change or add.
This project is licensed under the GNU GENERAL PUBLIC LICENSE. See the LICENSE file for details.