github/upsy-desky
1
1
Fork 0
mirror of https://github.com/tjhorner/upsy-desky.git synced 2026-01-06 22:23:58 -05:00
Code Issues Packages Projects Releases Wiki Activity

Update doc links

Browse Source
This commit is contained in:
TJ Horner
2023-02-01 09:29:57 -08:00
parent 67e1cf6881
commit 8c4924d9d9
2 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@@ -53,7 +53,7 @@ Any standing desk that uses RJ45 to connect to the keypad is likely compatible,
## Documentation
You can find everything you need in the [GitHub wiki](https://github.com/tjhorner/upsy-desky/wiki/Getting-Started).
You can find everything you need in the [documentation](https://upsy-desky.tjhorner.dev/docs/getting-started/).
## Licenses

4
reversing-firmware/README.md
View File

@@ -1,6 +1,6 @@
# Reverse Engineering Firmware
This is a special firmware designed to aid in the reverse engineering of new desk control box protocols. You can find the complete reverse engineering guide [here](https://github.com/tjhorner/upsy-desky/wiki/Reverse-Engineering-Guide).
This is a special firmware designed to aid in the reverse engineering of new desk control box protocols. You can find the complete reverse engineering guide [here](https://upsy-desky.tjhorner.dev/docs/advanced/reverse-engineering/).
You can flash this firmware on your stock Upsy Desky; no additional hardware is required. It uses ESPHome's [UART debugging feature](https://esphome.io/components/uart.html#debugging) to log all communication between the keypad and control box. You can use this data to reverse engineer the protocol based on the RE guide linked above.
@@ -8,4 +8,4 @@ You can flash this firmware on your stock Upsy Desky; no additional hardware is
Aside from the normal UART parameters like baud rate, it may be helpful to adjust the parameters in the UART debugging component to make the data more readable and easier to RE. Particularly useful is the `after` parameter, which allows you to log a string of bytes after some specified number of bytes, timeout, or delimiter. You can see the specific configuration options in the [ESPHome documentation](https://esphome.io/components/uart.html#debugging).
You may also wish to change the GPIO port to match the RX and TX pins on your control box if the defaults don't match yours. See the [GPIO Pinout](https://github.com/tjhorner/upsy-desky/wiki/GPIO-Pinout) mapping to see which RJ45 pins correspond to which GPIO pins.
You may also wish to change the GPIO port to match the RX and TX pins on your control box if the defaults don't match yours. See the [GPIO Pinout](https://upsy-desky.tjhorner.dev/docs/reference/gpio/) mapping to see which RJ45 pins correspond to which GPIO pins.