Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kennymc-c/ucr2-integration-requests
Integration for Unfolded Circle Remote Devices to send HTTP requests and Wake on LAN magic packets
https://github.com/kennymc-c/ucr2-integration-requests
Last synced: 5 days ago
JSON representation
Integration for Unfolded Circle Remote Devices to send HTTP requests and Wake on LAN magic packets
- Host: GitHub
- URL: https://github.com/kennymc-c/ucr2-integration-requests
- Owner: kennymc-c
- License: gpl-3.0
- Created: 2024-04-26T17:23:32.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-09-13T17:08:03.000Z (11 days ago)
- Last Synced: 2024-09-14T09:02:55.853Z (10 days ago)
- Language: Python
- Homepage:
- Size: 97.7 KB
- Stars: 5
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# HTTP Get/Post/Put/Patch & Wake on LAN Integration for Unfolded Circle Remote Two and Remote 3
## ⚠️ WARNING ⚠️
### Disclaimer: This software is at an early stage of development and may contain serious bugs that could affect system stability. Please use it at your own risk!
##
Integration for Unfolded Circle [Remote Two](https://www.unfoldedcircle.com/remote-two) and [Remote 3](https://www.unfoldedcircle.com) running [Unfolded OS](https://www.unfoldedcircle.com/unfolded-os) to send network requests to a specified url or mac address.
Using [uc-integration-api](https://github.com/aitatoi/integration-python-library), [requests](https://github.com/psf/requests) and [pywakeonlan](https://github.com/remcohaszing/pywakeonlan).
### Supported features
- Send http(s) get, post, patch & put requests to a specified url
- Set a custom timeout and deactivate ssl certificate verification
- Send Wake on LAN magic packets to a specified mac address
### Planned features
- Send Wake on LAN magic packets by entering the ip address
- Support for sending json and xml data in request body
*Planned improvements are labeled with #TODO in the code*
## Configuration
During the integration setup you can change the default http request timeout of 2 seconds to a custom value. You also can deactivate the ssl certificate verification. This is needed for self signed certificates. You can run the setup process again in the integration settings after adding entities to the remote.
## Usage
The integration exposes a media player entity for each supported request command. These entities only support the source feature. Just enter the desired url (including http(s)://) or mac address in the source field when you configure your activity/macro sequences or activity ui.
For http requests your server needs to respond with a *200 OK* status or any other informational or redirection http status codes (100s, 200s or 300s). 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.
Optional form data in the request body as key/value pairs can be added with a paragraph character (§) as a separator like this:
- https://httpbin.org/post§key1=value1,key2=value2
Note that if your url contains a paragraph character you need to url-encode it first (%C2%A7, see https://www.urlencoder.io)
### Setup
#### Requirements
- Python 3.10 or newer
- Install Libraries:
(using a [virtual environment](https://docs.python.org/3/library/venv.html) is highly recommended)
```shell
pip3 install -r requirements.txt
```
### Run
```shell
python3 intg-requests/driver.py
```
### Run as a Docker container
For 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](https://github.com/unfoldedcircle/integration-python-library#environment-variables)
in the Python integration library.
All data is mounted to `/usr/src/app`:
```shell
docker run --net=host -n 'ucr2-integration-requests' -v './ucr2-integration-requests':'/usr/src/app/':'rw' 'python:3.11' /usr/src/app/docker-entry.sh
```
## Build self-contained binary for Remote Two
*Note: Uploading custom integrations to the remote is not yet supported with the current firmware. The status can be tracked in this issue: [#79](https://github.com/unfoldedcircle/feature-and-bug-tracker/issues/79)*
Unfolded Circle recommends to create a single binary file that has everything in it as python on embedded systems is a nightmare.
To do that, we need to compile it on the target architecture as `pyinstaller` does not support cross compilation.
### x86-64 Linux
On x86-64 Linux we need Qemu to emulate the aarch64 target platform:
```bash
sudo apt install qemu binfmt-support qemu-user-static
docker run --rm --privileged multiarch/qemu-user-static --reset -p yes
```
Run pyinstaller:
```shell
docker run --rm --name builder \
--platform=aarch64 \
--user=$(id -u):$(id -g) \
-v "$PWD":/workspace \
docker.io/unfoldedcircle/r2-pyinstaller:3.11.6 \
bash -c \
"python -m pip install -r requirements.txt && \
pyinstaller --clean --onefile --name intg-requests intg-requests/driver.py"
```
### aarch64 Linux / Mac
On an aarch64 host platform, the build image can be run directly (and much faster):
```shell
docker run --rm --name builder \
--user=$(id -u):$(id -g) \
-v "$PWD":/workspace \
docker.io/unfoldedcircle/r2-pyinstaller:3.11.6 \
bash -c \
"python -m pip install -r requirements.txt && \
pyinstaller --clean --onefile --name intg-requests intg-requests/driver.py"
```
## Versioning
I use [SemVer](http://semver.org/) for versioning. For the versions available, see the
[tags and releases in this repository](/releases).
## Changelog
The major changes found in each new release are listed in the [changelog](CHANGELOG.md)
and under the GitHub [releases](/releases).
## Contributions
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.
## License
This project is licensed under the [**GNU GENERAL PUBLIC LICENSE**](https://choosealicense.com/licenses/gpl-3.0/).
See the [LICENSE](LICENSE) file for details.