From 8c4924d9d9d33f5d675b551d0b82ebf0e78cb9d4 Mon Sep 17 00:00:00 2001 From: TJ Horner Date: Wed, 1 Feb 2023 09:29:57 -0800 Subject: [PATCH] Update doc links --- README.md | 2 +- reversing-firmware/README.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index f654517..8f2d957 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/reversing-firmware/README.md b/reversing-firmware/README.md index 2d36751..a43cb5a 100644 --- a/reversing-firmware/README.md +++ b/reversing-firmware/README.md @@ -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. \ No newline at end of file +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. \ No newline at end of file