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 control Sony projectors that support the SDCP/PJ Talk protocol.
Using uc-integration-api and a modified and extended version of pySDCP that is included in this repository.
- Entities
- Commands & attributes
- Usage
- Installation
- Build
- Versioning
- Changelog
- Contributions
- License
- Media player
- Source select feature to choose the input from a list
- Remote
- Pre-defined buttons mappings and ui pages with all available commands that can be customized in the web configurator
- Use command sequences in the activity editor instead of creating a macro for each sequence. All command names have to be in upper case and separated by a comma
- Support for repeat, delay and hold
- Hold just repeats the command continuously for the given hold time. There is no native hold function for the SDCP protocol as with some ir devices to activate additional functions
- Sensor
- Lamp timer
- Lamp hours will be updated every time the projector is powered on or off by the remote and automatically every 30 minutes (can be changed in config.py) while the projector is powered on and the remote is not in sleep/standby mode or the integration is disconnected
- Lamp timer
- Picture position and advanced iris commands
- Needs testers as I only own a VPL-VW-270 that doesn't support lens memory and iris control
- Configure poller interval, SDCP & SDAP ports and PJTalk community in an advanced setup
- Power/error status sensor entity
Additional smaller planned improvements are labeled with #TODO in the code
- Turn On/Off/Toggle
- Mute/Unmute/Toggle
- Used for picture muting
- Cursor Up/Down/Left/Right/Enter
- The back command is also mapped to cursor left as there is no separate back command for the projector. Inside the setup menu cursor left has the same function as a typical back command.
- Home
- Opens the setup menu. Used instead of the menu feature because of the hard mapped home button when opening the entity from a profile page
- Source Select
- HDMI 1, HDMI 2
- State (On, Off, Unknown)
- Muted (True, False)
- Source
- Source List (HDMI 1, HDMI 2)
- Input HDMI 1 & 2
- Intended for the remote entity in addition to the source select feature of the media player entity
- Calibration Presets*
- Cinema Film 1, Cinema Film 2, Reference, TV, Photo, Game, Bright Cinema, Bright TV, User
- Aspect Ratios*
- Normal, Squeeze, Stretch**, V Stretch, Zoom 1:85, Zoom 2:35
- Motionfow*
- Off, Smoth High, Smoth Low, Impulse***, Combination***, True Cinema
- HDR*
- On, Off, Auto, Toggle
- 2D/3D Display Select**
- 2D, 3D, Auto
- 3D Format**
- Simulated 3D, Side-by-Side, Over-Under
- Lamp Control*
- High, Low
- Input Lag Reduction*
- On, Off
- Menu Position
- Bottom Left, Center
- Lens Control
- Lens Shift Up/Down/Left/Right
- Lens Focus Far/Near
- Lens Zoom Large/Small
* Only works if a video signal is present at the input
** May not work work with all video signals. Please refer to Sony's user manual
*** May not work on certain projector models that do not support this mode/feature. Please refer to Sony's user manual
If a command can't be processed or applied by the projector this will result in a bad request error on the remote. The response error message from the projector is shown in the integration log
- On, Off, Toggle
- Send command
- Command names have to be in upper case and separated by a comma
- Send command sequence
- All command names have to be in upper case and separated by a comma
The default button mappings and ui pages can be customized in the web configurator under Remotes/External.
| Button | Short Press command | Long Press command |
|---|---|---|
| BACK | Cursor Left | |
| HOME | Menu | |
| VOICE | Projector Info (Menu+Cursor Up) | Toggle HDR On/Off |
| VOLUME_UP/DOWN | Lens Zoom Large/Small | Lens Focus Far/Near |
| MUTE | Toggle Picture Muting | |
| DPAD_UP/DOWN/LEFT/RIGHT | Cursor Up/Down/Left/Right | Lens Shift Up/Down/Left/Right |
| DPAD_MIDDLE | Cursor Enter | |
| GREEN | Mode Preset Cinema Film 1 | |
| YELLOW | Mode Preset Cinema Film 2 | |
| RED | Mode Preset Bright TV | |
| BLUE | Mode Preset Bright Cinema | |
| CHANNEL_UP/DOWN | Input HDMI 1/2 | |
| PREV | Mode Preset Ref | Mode Preset Photo |
| PLAY | Mode Preset Game | |
| NEXT | Mode Preset User | Mode Preset TV |
| POWER | Power Toggle |
By default the integration checks the status of all media player entity attributes every 20 seconds while the remote is not in standby/sleep mode or disconnected from the integration. The interval can be changed in config.py. Set it to 0 to deactivate this function. When running on the remote as a custom integration the interval will be automatically set to 0 to reduce battery consumption and save cpu/memory usage.
The sensor value will be updated every time the projector is powered on or off by the remote and automatically every 30 minutes by default while the projector is powered on and the remote is not in sleep/standby mode or the integration is disconnected.
This integration supports one projector per integration instance. Multi device support is currently not planned for this integration but you could run the integration multiple times using different und unique driver IDs.
Usually all Sony projectors that support the PJTalk / SDCP protocol should be supported.
The following models have been tested with either pySDCP or this integration by personal testing:
- VPL-HW65ES
- VPL-VW100
- VPL-VW260
- VPL-VW270
- VPL-VW285
- VPL-VW315
- VPL-VW320
- VPL-VW328
- VPL-VW365
- VPL-VW515
- VPL-VW520
- VPL-VW528
- VPL-VW665
Please inform me if you have a projector that is not on this list and it works with pySDCP or this integration
Open the projectors web interface and go to Setup/Advanced Menu (left menu)/PJTalk, activate the Start PJ Talk Service checkbox and click on Apply.
During the initial setup the integration tries to query data from the projector via the SDAP advertisement protocol to generate a unique entity id. The default SDAP interval is 30 seconds. You can shorten the interval to a minimum value of 10 seconds under Setup/Advanced Menu/Advertisement/Interval.
- 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-sonysdcp-x.x.x-aarch64.tar.gz archive in the assets section from the latest release
The custom integration driver installation is currently only possible via the Core API.
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
UC plans to integrate the upload function to the web configurator once they get enough positive feedback from developers (and users). The current status can be tracked in this issue: #79.
- Firmware 1.7.12 or newer to support simple commands and remote entities
- Python 3.11
- Install Libraries:
(using a virtual environment is highly recommended)
pip3 install -r requirements.txtpython3 intg-sonysdcp/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-sonysdcp' -v './ucr2-integration-sonySDCP':'/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-sonysdcp intg-sonysdcp/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-sonysdcp intg-sonysdcp/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-sonysdcp/* artifacts/bin
mv artifacts/bin/intg-sonysdcp artifacts/bin/driver
cp driver.json artifacts/
tar czvf uc-intg-sonysdcp-aarch64.tar.gz -C artifacts .
rm -r dist build artifacts intg-sonysdcp.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.