From 2746e9d1142877c0b3f8181b75601a8f3aaf2011 Mon Sep 17 00:00:00 2001 From: Jonas Niesner Date: Tue, 16 May 2023 19:41:24 +0200 Subject: [PATCH] Update readme and added build Information --- README.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index c1275935..8a9eea96 100644 --- a/README.md +++ b/README.md @@ -23,11 +23,11 @@ On the 2.9" tags, both the UC8151 and SSD1619 display variants are supported - High transfer speeds - It can do about 5kbyte/s in favorable RF conditions. This allows for lower power - RF-friendly - We don't need to acknowledge EVERY packet, and we don't need to transfer data we already have -The entire setup requires a few tags, and an ESP32. A (preferably, but not necessarily) broken tag is used as an 802.15.4 radio for the ESP32. You'll need a ZBS_Flasher in order to flash both the AP with its firmware, and the tags. Using the 'mac' option on ZBS_Flasher makes sure a tag flashed with a custom firmware has a valid mac address; it used the stock mac address assigned to the tag if it hasn't been flashed before. If you want to set it yourself, you can edit the mac address in the infopage. The AP expects a tag with a mac that starts with 00:00, followed by 6 bytes. The MAC-address also needs to be set on the AP-tag. +The entire setup requires a few tags, and an ESP32. A tag is used as an 802.15.4 radio for the ESP32. You'll need a ZBS_Flasher in order to flash the tags. Using the 'mac' option on ZBS_Flasher makes sure a tag flashed with a custom firmware has a valid mac address; it used the stock mac address assigned to the tag if it hasn't been flashed before. If you want to set it yourself, you can edit the mac address in the infopage. The AP expects a tag with a mac that starts with 00:00, followed by 6 bytes. -Once flashed, you can hook the AP tag up to the ESP32 by connecting the tags serial lines to some free pins. Make sure you set the pins in settings.h, so that the ESP32 can communicate with it. This can be validated by checking the ESP32 debug output; you should see 'sync burst' displayed every 30 seconds +You can hook the AP tag up to the ESP32 with mod wires or a flex pcb. The esp will flash the AP fitmware to the Tag automatically. In some case, a power off on cicle is reqired. Please check the serial console output for status information. -You can access the ESP32 with any web browser after connecting it to your WiFi Network. The file browser is located at /edit. For sending data to tags, you'll need to upload the information in 'data' to the ESP32's filesystem. After uploading, you can access the status screen at /index.html. If everything is working, you should be able to see tags synchronising to the network. After uploading a suitable .bmp file to the filesystem, this file can be sent to the tag by entering it's 6-byte mac address and filename. +You can access the ESP32 with any web browser after connecting it to your WiFi Network. The file browser is located at /edit. For sending data to tags, you'll need to upload the information in 'data' to the ESP32's filesystem or over HTTP. After uploading, you can access the status screen at /index.html. If everything is working, you should be able to see tags synchronising to the network. After uploading a suitable .bmp file to the filesystem, this file can be sent to the tag by entering it's 6-byte mac address and filename. ## The protocol explained - The tag checks in with the AP every 40+ seconds. Actual check-in interval is highly dependent on RF conditions @@ -71,3 +71,9 @@ You can access the ESP32 with any web browser after connecting it to your WiFi N - atc1441 Hats off to these legends! + +## Automated Builds +- After a PR gets merged to the main branch, the esp 32 code will automatically be compiled. This can take up to 20 minutes. +- Information about the latest builds can be found below +builds +