index 21c4ed3fd5c4f24931ef0defdb193836353bf6a1..691746b8572e9b74e1d2946994f7170c86c8211a 100644 (file)
# _esptic_
-Quick & dirty implementation of tic2json for ESP8266/ESP32.
-Gets TIC data on RX pin, outputs formatted JSON on UART TX.
+Implementation of tic2json for ESP8266/ESP32.
+Gets TIC data on RX pin, outputs formatted JSON over UDP.
### Configure the project
`idf.py menuconfig`
-* Set TIC baudrate and UART under Component config -> esptic
-* Set TIC version under Component config -> tic2json
+* Under Component config -> esptic, set the following:
+ * UART for receiving TIC frames and TIC baudrate
+ * GPIO number for LED heartbeat and LED active state
+ * WiFi SSID and password
+ * Target UDP host and port
+* Under Component config -> tic2json, set TIC version
### Build and Flash
@@ -17,3 +21,5 @@ Build the project and flash it to the board:
`idf.py flash`
See the Getting Started Guide for full steps to configure and use ESP-IDF to build projects.
+
+Tested working on ESP8266 and ESP32.