diff options
Diffstat (limited to 'python-pi-display-webthing.spec')
| -rw-r--r-- | python-pi-display-webthing.spec | 267 |
1 files changed, 267 insertions, 0 deletions
diff --git a/python-pi-display-webthing.spec b/python-pi-display-webthing.spec new file mode 100644 index 0000000..a319e78 --- /dev/null +++ b/python-pi-display-webthing.spec @@ -0,0 +1,267 @@ +%global _empty_manifest_terminate_build 0 +Name: python-pi-display-webthing +Version: 0.1.8 +Release: 1 +Summary: A web connected LCD display module +License: MIT +URL: https://github.com/grro/pi_display_webthing +Source0: https://mirrors.aliyun.com/pypi/web/packages/bd/33/d412fa64e39cd566d13bd2b5bf934a553de31aa532052b15c3f667b83196/pi_display_webthing-0.1.8.tar.gz +BuildArch: noarch + +Requires: python3-webthing +Requires: python3-smbus2 +Requires: python3-RPLCD + +%description +# pi_display_webthing +A web connected LCD display module + +This project provides a [webthing API](https://iot.mozilla.org/wot/) to an I2C LCD module such as a [HD44780 1602 LCD Module](https://amzn.to/2TffbbL) on the Raspberry Pi. +As a webthing, the LCD can be discovered and controlled by *home automation systems* or custom solutions supporting the webthing API. + + + +The pi_display_webthing exposes an http webthing endpoint which supports controlling the display via http. E.g. +``` +# webthing has been started on host 192.168.0.23 + +curl http://192.168.0.23:8070/properties + +{ + "text": "Hello\n\rraspi", + "upper_layer_text": "Hello\n\rraspi", + "upper_layer_text_ttl": -1, + "middle_layer_text": "uploaded: 41", + "middle_layer_text_ttl": -1, + "lower_layer_text": "", + "lower_layer_text_ttl": -1 +} +``` +Here, the text *Hello\n\rraspi* will be displayed. The text of the middle layer *uploaded: 41* will be covered by the upper layer. +If the text of the upper layer will be cleaned, the displayed text is *uploaded: 41*. +By setting the ttl of the layer, the text of the layer will be disappear after expiration of the ttl. Value -1 means that ttl is deactivated. + +The text of a dedicated layer can be updated as shown below +``` +curl -v -X PUT -d "{\"upper_layer_text\": \"Hello world\"}" http://192.168.1.101:8088/properties/upper_layer_text +``` + +The RaspberryPi/LCD hardware setup and wiring may look like [HD44780 1602 LCD module](docs/layout.png). By default, +Raspberry Pi OS disables I2C. Please refer [Configure I2C](docs/configure_i2c.md) to activate I2C and to +detect the address of the LCD module. + +To install pi_display_webthing you may use [Docker](https://phoenixnap.com/kb/docker-on-raspberry-pi) or [PIP](https://realpython.com/what-is-pip/) package manager such as shown below + +**Docker approach** +``` +sudo docker run -p 8070:8070 --device /dev/i2c-1:/dev/i2c-1 -e i2c_expander=PCF8574 -e i2c_address=0x27 grro/pi_display_webthing:0.1.0 +``` + +**PIP approach** +``` +sudo pip install pi_display_webthing +``` + +After this installation you may start the webthing http endpoint inside your python code or via command line using +``` +sudo display --command listen --port 8070 --i2c_expander PCF8574 --i2c_address 0x27 +``` +Here, the webthing API will be bind on port 8070 using a 2/16 display layout on address 0x27. +Further more the port I2C port expander name has to be set. The expander name should be written on the microchip. +Supported port expanders are *PCF8574*, *MCP23008* and *MCP23017* + +Alternatively to the *listen* command, you can use the *register* command to register and start the webthing service as systemd unit. +By doing this the webthing service will be started automatically on boot. Starting the server manually using the *listen* command is no longer necessary. +``` +sudo display --command register --port 8070 --i2c_expander PCF8574 --i2c_address 0x27 +``` + + + + +%package -n python3-pi-display-webthing +Summary: A web connected LCD display module +Provides: python-pi-display-webthing +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-pi-display-webthing +# pi_display_webthing +A web connected LCD display module + +This project provides a [webthing API](https://iot.mozilla.org/wot/) to an I2C LCD module such as a [HD44780 1602 LCD Module](https://amzn.to/2TffbbL) on the Raspberry Pi. +As a webthing, the LCD can be discovered and controlled by *home automation systems* or custom solutions supporting the webthing API. + + + +The pi_display_webthing exposes an http webthing endpoint which supports controlling the display via http. E.g. +``` +# webthing has been started on host 192.168.0.23 + +curl http://192.168.0.23:8070/properties + +{ + "text": "Hello\n\rraspi", + "upper_layer_text": "Hello\n\rraspi", + "upper_layer_text_ttl": -1, + "middle_layer_text": "uploaded: 41", + "middle_layer_text_ttl": -1, + "lower_layer_text": "", + "lower_layer_text_ttl": -1 +} +``` +Here, the text *Hello\n\rraspi* will be displayed. The text of the middle layer *uploaded: 41* will be covered by the upper layer. +If the text of the upper layer will be cleaned, the displayed text is *uploaded: 41*. +By setting the ttl of the layer, the text of the layer will be disappear after expiration of the ttl. Value -1 means that ttl is deactivated. + +The text of a dedicated layer can be updated as shown below +``` +curl -v -X PUT -d "{\"upper_layer_text\": \"Hello world\"}" http://192.168.1.101:8088/properties/upper_layer_text +``` + +The RaspberryPi/LCD hardware setup and wiring may look like [HD44780 1602 LCD module](docs/layout.png). By default, +Raspberry Pi OS disables I2C. Please refer [Configure I2C](docs/configure_i2c.md) to activate I2C and to +detect the address of the LCD module. + +To install pi_display_webthing you may use [Docker](https://phoenixnap.com/kb/docker-on-raspberry-pi) or [PIP](https://realpython.com/what-is-pip/) package manager such as shown below + +**Docker approach** +``` +sudo docker run -p 8070:8070 --device /dev/i2c-1:/dev/i2c-1 -e i2c_expander=PCF8574 -e i2c_address=0x27 grro/pi_display_webthing:0.1.0 +``` + +**PIP approach** +``` +sudo pip install pi_display_webthing +``` + +After this installation you may start the webthing http endpoint inside your python code or via command line using +``` +sudo display --command listen --port 8070 --i2c_expander PCF8574 --i2c_address 0x27 +``` +Here, the webthing API will be bind on port 8070 using a 2/16 display layout on address 0x27. +Further more the port I2C port expander name has to be set. The expander name should be written on the microchip. +Supported port expanders are *PCF8574*, *MCP23008* and *MCP23017* + +Alternatively to the *listen* command, you can use the *register* command to register and start the webthing service as systemd unit. +By doing this the webthing service will be started automatically on boot. Starting the server manually using the *listen* command is no longer necessary. +``` +sudo display --command register --port 8070 --i2c_expander PCF8574 --i2c_address 0x27 +``` + + + + +%package help +Summary: Development documents and examples for pi-display-webthing +Provides: python3-pi-display-webthing-doc +%description help +# pi_display_webthing +A web connected LCD display module + +This project provides a [webthing API](https://iot.mozilla.org/wot/) to an I2C LCD module such as a [HD44780 1602 LCD Module](https://amzn.to/2TffbbL) on the Raspberry Pi. +As a webthing, the LCD can be discovered and controlled by *home automation systems* or custom solutions supporting the webthing API. + + + +The pi_display_webthing exposes an http webthing endpoint which supports controlling the display via http. E.g. +``` +# webthing has been started on host 192.168.0.23 + +curl http://192.168.0.23:8070/properties + +{ + "text": "Hello\n\rraspi", + "upper_layer_text": "Hello\n\rraspi", + "upper_layer_text_ttl": -1, + "middle_layer_text": "uploaded: 41", + "middle_layer_text_ttl": -1, + "lower_layer_text": "", + "lower_layer_text_ttl": -1 +} +``` +Here, the text *Hello\n\rraspi* will be displayed. The text of the middle layer *uploaded: 41* will be covered by the upper layer. +If the text of the upper layer will be cleaned, the displayed text is *uploaded: 41*. +By setting the ttl of the layer, the text of the layer will be disappear after expiration of the ttl. Value -1 means that ttl is deactivated. + +The text of a dedicated layer can be updated as shown below +``` +curl -v -X PUT -d "{\"upper_layer_text\": \"Hello world\"}" http://192.168.1.101:8088/properties/upper_layer_text +``` + +The RaspberryPi/LCD hardware setup and wiring may look like [HD44780 1602 LCD module](docs/layout.png). By default, +Raspberry Pi OS disables I2C. Please refer [Configure I2C](docs/configure_i2c.md) to activate I2C and to +detect the address of the LCD module. + +To install pi_display_webthing you may use [Docker](https://phoenixnap.com/kb/docker-on-raspberry-pi) or [PIP](https://realpython.com/what-is-pip/) package manager such as shown below + +**Docker approach** +``` +sudo docker run -p 8070:8070 --device /dev/i2c-1:/dev/i2c-1 -e i2c_expander=PCF8574 -e i2c_address=0x27 grro/pi_display_webthing:0.1.0 +``` + +**PIP approach** +``` +sudo pip install pi_display_webthing +``` + +After this installation you may start the webthing http endpoint inside your python code or via command line using +``` +sudo display --command listen --port 8070 --i2c_expander PCF8574 --i2c_address 0x27 +``` +Here, the webthing API will be bind on port 8070 using a 2/16 display layout on address 0x27. +Further more the port I2C port expander name has to be set. The expander name should be written on the microchip. +Supported port expanders are *PCF8574*, *MCP23008* and *MCP23017* + +Alternatively to the *listen* command, you can use the *register* command to register and start the webthing service as systemd unit. +By doing this the webthing service will be started automatically on boot. Starting the server manually using the *listen* command is no longer necessary. +``` +sudo display --command register --port 8070 --i2c_expander PCF8574 --i2c_address 0x27 +``` + + + + +%prep +%autosetup -n pi_display_webthing-0.1.8 + +%build +%py3_build + +%install +%py3_install +install -d -m755 %{buildroot}/%{_pkgdocdir} +if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi +if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi +if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi +if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi +pushd %{buildroot} +if [ -d usr/lib ]; then + find usr/lib -type f -printf "\"/%h/%f\"\n" >> filelist.lst +fi +if [ -d usr/lib64 ]; then + find usr/lib64 -type f -printf "\"/%h/%f\"\n" >> filelist.lst +fi +if [ -d usr/bin ]; then + find usr/bin -type f -printf "\"/%h/%f\"\n" >> filelist.lst +fi +if [ -d usr/sbin ]; then + find usr/sbin -type f -printf "\"/%h/%f\"\n" >> filelist.lst +fi +touch doclist.lst +if [ -d usr/share/man ]; then + find usr/share/man -type f -printf "\"/%h/%f.gz\"\n" >> doclist.lst +fi +popd +mv %{buildroot}/filelist.lst . +mv %{buildroot}/doclist.lst . + +%files -n python3-pi-display-webthing -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Tue Jun 20 2023 Python_Bot <Python_Bot@openeuler.org> - 0.1.8-1 +- Package Spec generated |