Socket
Book a DemoInstallSign in
Socket

benqprojector

Package Overview
Dependencies
Maintainers
1
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

benqprojector

Library to control BenQ projectors.

pipPyPI
Version
0.1.8
Maintainers
1

Python library to control BenQ projectors

Python GitHub Release Licence Maintainer
GitHub Sponsors PayPal BuyMeCoffee Patreon

Introduction

A Python library to control BenQ projectors via the serial or network interface, including serial to network bridges such as esp-link.

Features

  • Connects to a BenQ projector over serial or network interface
  • Sending commands to projectors
  • Reading the projector status
  • Detect projector capabilities
  • Uses asynchronous IO

Protocol

BenQ projectors and flat panels with a serial port can support one of three protocols. This library supports BenQ projectors in the L, P, T, W and X series, and likely others.

This Python library works if your projector supports the following command structure:

<CR>*<key>=<value>#<CR>

Where <CR> is a Carriage Return

Examples:
Power on : <CR>*pow=on#<CR>
Power off : <CR>*pow=off#<CR>
Change source to HDMI: <CR>*sour=hdmi#<CR>

This library does not implement the PJLink protocol, but a proprietary BenQ protocol instead. The PJLink protocol is covered by other libraries.

Hardware

Serial port

I'm using a generic serial to USB converter to connect to my projector. The projector has a male DB9 connector, thus you need a female connector on your USB converter.

You can look up and change the baud rate in the menu of your BenQ projector.

Network connected projectors

The commands as described above also work over a network connection. Although I don't own such a projector I have implemented the network functionality using a serial to WiFi bridge. The network support for integrated networked BenQ projectors is thus experimental. Let me know if your network connected BenQ projector works.

Example of a serial to WiFi bridge using a serial to TTL converter and a Wemos C3 Mini:

It has to be said that a direct serial connection to the projector is much more responsive than using a serial to WiFi bridge. Maybe this is different on an integrated networked BenQ projector or using ethernet instead of WiFi.

Supported projectors

The following projectors are known to work:

  • HT4550i
  • MS521P
  • MW519
  • TH585
  • TK800m
  • W1070
  • W1100
  • W1110
  • W1140
  • W1250
  • W4000i
  • X3000i

The following projectors are not tested but use the same protocol according to the documentation:

Others in the L, P, T, W and X Series

Not supported:

  • RP552
  • RP552H
  • RP840G
  • RP653
  • RP703
  • RP750
  • RP750K
  • RP652
  • RP702
  • RP790S
  • RP705H

Some projectors need to be powered on to be able to detect the model and the library to work.

Please let me know if your projector is also supported by this Python library so I can improve the overview of supported projectors.

Installation

To install the Python BenQ projector library use the Package Installer for Python PIP:

pip3 install benqprojector

If you intend to only use the library for the CLI it is recommended to install the library in a virtual environment:

python3 -m venv benqprojector
. benqprojector/bin/activate
pip3 install benqprojector
deactivate

benqprojector CLI

You can use the Python BenQ projector library directly from the command line to turn on and off your projector using the following syntax:

If you installed the library in a virtual environment then first enable the virtual environment before executing any of the commands:

. benqprojector/bin/activate

Status of the projector: python3 -m benqprojector serial <serial port> <baud> status
Turn on the projector: python3 -m benqprojector serial <serial port> <baud> on
Turn off the projector: python3 -m benqprojector serial <serial port> <baud> off
Monitor the projector status: python3 -m benqprojector serial <serial port> <baud> monitor

Where <serial port> is the serial port your projector is connected to and <baud> the baud rate of the projector.

Or if your projector is connected using a serial to network bridge:

Status of the projector: python3 -m benqprojector telnet <host> <port> status
Turn on the projector: python3 -m benqprojector telnet <host> <port> on
Turn off the projector: python3 -m benqprojector telnet <host> <port> off Monitor the projector status: python3 -m benqprojector telnet <host> <port> monitor

Where <host> is the hostname or IP address of the projector and <port> the optional port number of the projector. If no port number is given the default port number 8000 is used.

Detecting your projector capabilities

The benqprojector CLI can detect the commands, sources and modes your projector supports. If you would like your projector to be fully supported by this Python library please run this command and create an issue on GitHub with the output attached.

To examine your projector capabilities:

python3 -m benqprojector serial <serial port> <baud> examine

Your projector needs to be powered on and on an active source to be able to detect all your projector capabilities.

Troubleshooting

You can add the --debug flag to any CLI command to get more details on what's going on. Like so:

python3 -m benqprojector serial <serial port> <baud> status --debug

You can also add the --record flag to any CLI command to have the communication from the projector recorded into a file. Like so:

python3 -m benqprojector serial <serial port> <baud> status --record

Support my work

Do you enjoy using this Python library? Please consider supporting my work through one of the following platforms. Your contribution is greatly appreciated and keeps me motivated:

GitHub Sponsors PayPal BuyMeCoffee Patreon

Hire me

If you're in need of a freelance Python developer for your project please contact me, you can find my email address on my GitHub profile.

FAQs

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts