fabian/pitrix
1
0
Fork 0
Code Issues 8 Releases Activity
116 Commits 1 Branch 0 Tags 3.4 MiB
C++ 82.9%
Ruby 10.8%
C 5.8%
Shell 0.4%
Gnuplot 0.1%
4fdd1d3739
Go to file
Fabian Schlenz 4fdd1d3739 Added animation 'cake'.
2019-06-14 05:32:55 +02:00
include Added animation 'cake'. 2019-06-14 05:32:55 +02:00
lib Arduino IDE -> PlatformIO 2019-05-27 21:17:05 +02:00
src Added animation 'cake'. 2019-06-14 05:32:55 +02:00
test Arduino IDE -> PlatformIO 2019-05-27 21:17:05 +02:00
.drone.yml drone.yml: Nicer notifications. 2019-06-11 19:44:53 +02:00
.gitignore Added .pioenvs and .piolibdeps to .gitignore. 2019-06-12 20:58:22 +02:00
.travis.yml Arduino IDE -> PlatformIO 2019-05-27 21:17:05 +02:00
platformio.ini Moved platform-specific code related to WiFi and services to my_wifi.h. Also, made the HTTP server stuff compatible to ESP32. 2019-06-13 06:01:44 +02:00
README.md Added HTTP REST API. 2019-06-12 20:57:31 +02:00

README.md

pitrix

What is pitrix?

pitrix is a software to run on an ESP8266 microncontroller connected to a LED matrix. It will display the time and a few other nice effects and stuff.

pitrix fetches the current time via NTP, is controllable via MQTT and can be flashed over-the-air, so you don't need to disassemble your nice-looking LED matrix everytime you want to update the software.

How to use

Checkout the code, rename include/config.sample.h to include/config.h and edit it to match your preferences / environment.

Then compile and flash it, preferably using PlatformIO.

Control it

Currently, control is possible via MQTT and / or HTTP REST API. To use MQTT, you have to define MQTT_ENABLE and configure your MQTT sever's credentials. MQTT_TOPICis set ininclude/config.hand defaults topitrix`.

To use the HTTP REST API, you have to define HTTP_SERVER_ENABLE and set a port number to listen on (80 is set by default).

Possible commands / topics are:

  • MQTT_TOPIC/mode / POST /mode lets you select an effect to show. See src/effects.cpp for a list. Default effect is cycle, which will cycle through some of the available effects. Another effect is off, which will just display black, effectively turning the display off. (pitrix stays running, so you can turn it on again by simply selecting another mode.)
  • MQTT_TOPIC/brightness / POST /brightness sets the brightness of the display. Valid values are between 1 (darkest possible setting) and 255 (maximum brightness).
  • MQTT_TOPIC/reboot / POST /reboot reboots pitrix. Send any value.

You can set retained values to have pitrix read them at startup, effectively setting a default effect or brightness. (Do NOT set a retained value for MQTT_TOPIC/reboot unless you want pitrix to reboot all the time.)

Monitor it

The current status ("ONLINE" or "OFFLINE") of pitrix will be set at MQTT_TOPIC/status.

If you enabled MQTT_REPORT_METRICS, metrics are sent via MQTT every 15 seconds:

  • MQTT_TOPIC/free_heap contains the free heap memory in Bytes.
  • MQTT_TOPIC/uptime contains the uptime of pitrix in seconds.
  • MQTT_TOPIC/fps contains the currently reached frames per second.

If you enabled HTTP server, you can always make GET requests to /free_heap, /uptime or /fps to get those values.

If you enabled DEBUG, log messages will be sent to MQTT_TOPIC/log.