0.4.0

.github/FUNDING.yml

@@ -0,0 +1 @@
+ko_fi: tjhorner

.github/workflows/build.yaml

@@ -20,7 +20,7 @@ jobs:
       - name: Compile Release Firmware
         working-directory: firmware
         run: |
-          esphome compile config.yaml
+          esphome compile stock.yaml
           mkdir -p bin
           cp .esphome/build/upsy-desky/.pioenvs/upsy-desky/firmware-factory.bin bin/firmware-factory.bin
           cp .esphome/build/upsy-desky/.pioenvs/upsy-desky/firmware.bin bin/firmware.bin

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
 

docs/fulfillment.md

@@ -0,0 +1,31 @@
+# Order Fulfillment Process
+
+I wrote this out in order to help my future self if I ever go on hiatus or something. But it could be useful if you're starting to sell a similar product and are wondering what the process is like.
+
+## Batch Order & Packing Slips
+
+When ready to start fulfilling orders, export the unshipped orders from Tindie and generate packing slips to print using [this tool](https://github.com/tjhorner/tindie-packing-slip-generator).
+
+## Shipping Labels
+
+Upload the order CSV from Tindie to Pirate Ship to generate the shipping labels. If needed, make sure to split the CSV based on shipping speed (first class, priority, etc).
+
+Print the shipping labels for the batch on a 4x6 label printer.
+
+## Provision & QA Boards
+
+Grab the amount of boards needed for the order, and send each of them through the QA process, which is semi-automated.
+
+Flash the test target firmware to each board, and plug it in via RJ45 to a test host board. Plug a USB-C cable into the host board and watch for six flashes of the host's LED. If it flashes 6 times, the test is complete and QA is passed. Place a QA sticker on the back.
+
+## Assemble Enclosure
+
+If the customer opted for one, put the boards in enclosures and screw them in place.
+
+## Flash Firmware
+
+Flash the stock firmware on each of the boards using [this tool](https://shop.horner.tj/things/upsy-desky/setup/stock), via USB-C.
+
+## Pack & Ship
+
+Place shipping label for the order on the box. Fold the shipping label, place in the box. Put the items in bubble wrap, and place in the box. Seal the box, and ship it off. Repeat until done with batch.

firmware/README.md

@@ -0,0 +1,16 @@
+# Firmware Configs
+
+This directory contains [ESPHome](https://esphome.io) config files for the Upsy Desky.
+
+It is organized like so:
+
+- `base.yaml`: The base essential configuration, which contains components for reading the desk height, preset buttons, etc.
+- `stock.yaml`: Inherits everything from `base.yaml` and adds components which are useful on stock firmware, such as the WiFi hotspot, web server, and Improv Serial
+- `debug.yaml`: Inherits everything from `stock.yaml` and adds components which are useful for debugging
+
+## Addons
+
+Major parts of the config are separated into "addons" so they can be easily included or excluded. The following addons are available:
+
+- `presets.yaml`: Adds support for recalling and setting presets on the desk control box
+- `runtime-config.yaml`: Adds support for runtime configuration options (you might want to remove this if you are configuring everything via ESPHome yaml)

firmware/addons/presets.yaml

@@ -0,0 +1,105 @@
+output:
+  - platform: gpio
+    inverted: true
+    id: button_bit1
+    pin: ${button_bit1_pin}
+
+  - platform: gpio
+    inverted: true
+    id: button_bit2
+    pin: ${button_bit2_pin}
+
+  - platform: gpio
+    inverted: true
+    id: button_bit4
+    pin: ${button_bit4_pin}
+
+  - platform: gpio
+    inverted: true
+    id: button_m
+    pin: ${button_m_pin}
+
+button:
+  # Recall Presets
+  - platform: template
+    id: recall_preset_1
+    name: "Preset 1"
+    icon: "mdi:numeric-1-box"
+    on_press:
+      - output.turn_on: button_bit1
+      - output.turn_on: button_bit2
+      - delay: 1s
+      - output.turn_off: button_bit2
+      - output.turn_off: button_bit1
+
+  - platform: template
+    id: recall_preset_2
+    name: "Preset 2"
+    icon: "mdi:numeric-2-box"
+    on_press:
+      - output.turn_on: button_bit4
+      - delay: 100ms
+      - output.turn_off: button_bit4
+
+  - platform: template
+    id: recall_preset_3
+    name: "Preset 3"
+    icon: "mdi:numeric-3-box"
+    on_press:
+      - output.turn_on: button_bit2
+      - output.turn_on: button_bit4
+      - delay: 100ms
+      - output.turn_off: button_bit4
+      - output.turn_off: button_bit2
+
+  - platform: template
+    id: recall_preset_4
+    name: "Preset 4"
+    icon: "mdi:numeric-4-box"
+    on_press:
+      - output.turn_on: button_bit4
+      - output.turn_on: button_bit1
+      - delay: 100ms
+      - output.turn_off: button_bit1
+      - output.turn_off: button_bit4
+
+  # Set Presets
+  - platform: template
+    name: "Set Preset 1"
+    entity_category: "config"
+    icon: "mdi:numeric-1-box-multiple"
+    on_press:
+      - output.turn_on: button_m
+      - delay: 100ms
+      - output.turn_off: button_m
+      - button.press: recall_preset_1
+
+  - platform: template
+    name: "Set Preset 2"
+    entity_category: "config"
+    icon: "mdi:numeric-2-box-multiple"
+    on_press:
+      - output.turn_on: button_m
+      - delay: 100ms
+      - output.turn_off: button_m
+      - button.press: recall_preset_2
+
+  - platform: template
+    name: "Set Preset 3"
+    entity_category: "config"
+    icon: "mdi:numeric-3-box-multiple"
+    on_press:
+      - output.turn_on: button_m
+      - delay: 100ms
+      - output.turn_off: button_m
+      - button.press: recall_preset_3
+
+  - platform: template
+    name: "Set Preset 4"
+    entity_category: "config"
+    icon: "mdi:numeric-4-box-multiple"
+    on_press:
+      - output.turn_on: button_m
+      - delay: 100ms
+      - output.turn_off: button_m
+      - button.press: recall_preset_4

firmware/addons/runtime-config.yaml

@@ -0,0 +1,56 @@
+select:
+  - platform: template
+    name: "Height Decoder Variant"
+    entity_category: "config"
+    optimistic: true
+    restore_value: true
+    options:
+      - uplift
+      - jarvis
+      - omnidesk
+    initial_option: ${standing_desk_variant}
+    on_value:
+      then:
+        lambda: "id(desk_height)->set_decoder_variant(x);"
+  - platform: template
+    name: "Height Units"
+    entity_category: "config"
+    optimistic: true
+    restore_value: true
+    options:
+      - in
+      - cm
+    initial_option: ${default_height_units}
+    on_value:
+      then:
+        lambda: |
+          id(desk_height)->set_unit_of_measurement(x);
+          id(target_desk_height)->traits.set_unit_of_measurement(x);
+
+number:
+  - platform: template
+    name: "Min Target Height"
+    entity_category: "config"
+    min_value: 0
+    max_value: 150
+    step: 0.1
+    optimistic: true
+    restore_value: true
+    initial_value: ${standing_desk_min_height}
+    on_value:
+      then:
+        lambda: |
+          id(target_desk_height)->traits.set_min_value(x);
+  - platform: template
+    name: "Max Target Height"
+    entity_category: "config"
+    min_value: 0
+    max_value: 150
+    step: 0.1
+    optimistic: true
+    restore_value: true
+    initial_value: ${standing_desk_max_height}
+    on_value:
+      then:
+        lambda: |
+          id(target_desk_height)->traits.set_max_value(x);

firmware/addons/stable-ids.yaml

@@ -0,0 +1,35 @@
+# This file provides stable entity IDs for various components, in order to be used in the HTTP API.
+
+# ESPHome derives entity IDs (internally called "object IDs") from the component name, which is
+# used as the ID in the HTTP API endpoints. Unfortunately there is no way to control them so they
+# are set independently of the name, so this is a weird workaround for that.
+
+sensor:
+  - platform: copy
+    source_id: desk_height
+    internal: true
+    name: "desk_height"
+
+number:
+  - platform: copy
+    source_id: target_desk_height
+    internal: true
+    name: "target_desk_height"
+
+button:
+  - platform: copy
+    source_id: recall_preset_1
+    internal: true
+    name: "desk_preset_1"
+  - platform: copy
+    source_id: recall_preset_2
+    internal: true
+    name: "desk_preset_2"
+  - platform: copy
+    source_id: recall_preset_3
+    internal: true
+    name: "desk_preset_3"
+  - platform: copy
+    source_id: recall_preset_4
+    internal: true
+    name: "desk_preset_4"

firmware/base.yaml

@@ -0,0 +1,63 @@
+# Essential ESPHome config options
+esphome:
+  name: "${name}"
+  friendly_name: "${friendly_name}"
+  name_add_mac_suffix: true
+  on_boot:
+    then:
+      # Wakes up the desk and reports height
+      - uart.write:
+          id: handset_tx
+          data: [ 0x0 ]
+  project:
+    name: tj_horner.upsy_desky
+    version: "0.4.0"
+
+uart:
+  id: handset_tx
+  tx_pin: 16
+  baud_rate: 9600
+
+esp32:
+  board: esp32dev
+
+# Configurable options
+substitutions:
+  name: "upsy-desky"
+  friendly_name: "Upsy Desky"
+  desk_height_name: "Desk Height"
+  target_desk_height_name: "Target Desk Height"
+
+  # Standing Desk Component Config
+  standing_desk_uart_rx_pin: "17"
+  standing_desk_up_pin: "21"
+  standing_desk_down_pin: "22"
+  standing_desk_variant: "uplift"
+  standing_desk_min_height: "25.2"
+  standing_desk_max_height: "50.8"
+
+  # Presets Addon Config
+  button_bit1_pin: "21"
+  button_bit2_pin: "22"
+  button_bit4_pin: "19"
+  button_m_pin: "18"
+
+  # Runtime Config Defaults
+  default_height_units: "in" # Must be "in" or "cm"
+
+packages:
+  standing_desk: github://tjhorner/esphome-standing-desk/configs/template.yaml@master
+  addon_presets: !include addons/presets.yaml
+  addon_stable_ids: !include addons/stable-ids.yaml
+  addon_runtime_config: !include addons/runtime-config.yaml
+
+button:
+  - platform: restart
+    name: "Restart"
+
+light:
+  - platform: status_led
+    id: upsy_desky_status_led
+    name: "Status LED"
+    pin: GPIO23
+    restore_mode: RESTORE_DEFAULT_ON

firmware/config.yaml

@@ -1,132 +1,8 @@
-substitutions:
-  name: "upsy-desky"
-  friendly_name: "Upsy Desky"
+# This file is here for reverse compatibility. Older versions of the firmware
+# pointed to `config.yaml` instead of `base.yaml`. That file also included the
+# config found in `stock.yaml`, which is why it's being included here.
 
-  # Defaults
-  standing_desk_uart_rx_pin: "17"
-  standing_desk_up_pin: "21"
-  standing_desk_down_pin: "22"
-  standing_desk_variant: "uplift"
-  standing_desk_min_height: "25.2"
-  standing_desk_max_height: "50.8"
-
-  # Presets
-  button_bit1_pin: "21"
-  button_bit2_pin: "22"
-  button_bit4_pin: "19"
-  button_m_pin: "18"
-
-esphome:
-  name: "${name}"
-  name_add_mac_suffix: true
-  on_boot:
-    then:
-      # Wakes up the desk and reports height
-      - uart.write:
-          id: handset_tx
-          data: [ 0x0 ]
-  project:
-    name: tj_horner.upsy_desky
-    version: "0.2.0"
-
-dashboard_import:
-  package_import_url: github://tjhorner/upsy-desky/firmware/config.yaml
-
-uart:
-  id: handset_tx
-  tx_pin: 16
-  baud_rate: 9600
-
-esp32:
-  board: esp32dev
-
-logger:
-  level: INFO
-
-wifi:
-  ap:
-    password: "hunter2hunter2"
-
-captive_portal:
-
-improv_serial:
-
-api:
-  password: ""
-  reboot_timeout: 0s
-
-web_server:
-  port: 80
-
-ota:
-  password: ""
+# Please use `base.yaml` for new configurations and customizations.
 
 packages:
-  standing_desk: github://tjhorner/esphome-standing-desk/configs/template.yaml@master
-  presets_addon: github://tjhorner/esphome-standing-desk/configs/addons/presets.yaml@master
-
-select:
-  - platform: template
-    name: "${friendly_name} Height Decoder Variant"
-    entity_category: "config"
-    optimistic: true
-    restore_value: true
-    options:
-      - uplift
-      - jarvis
-    initial_option: ${standing_desk_variant}
-    on_value:
-      then:
-        lambda: "id(desk_height)->set_decoder_variant(x);"
-  - platform: template
-    name: "${friendly_name} Height Units"
-    entity_category: "config"
-    optimistic: true
-    restore_value: true
-    options:
-      - in
-      - cm
-    initial_option: in
-    on_value:
-      then:
-        lambda: |
-          id(desk_height)->set_unit_of_measurement(x);
-          id(target_desk_height)->traits.set_unit_of_measurement(x);
-
-number:
-  - platform: template
-    name: "${friendly_name} Min Target Height"
-    entity_category: "config"
-    min_value: 0
-    max_value: 150
-    step: 0.1
-    optimistic: true
-    restore_value: true
-    initial_value: ${standing_desk_min_height}
-    on_value:
-      then:
-        lambda: |
-          id(target_desk_height)->traits.set_min_value(x);
-  - platform: template
-    name: "${friendly_name} Max Target Height"
-    entity_category: "config"
-    min_value: 0
-    max_value: 150
-    step: 0.1
-    optimistic: true
-    restore_value: true
-    initial_value: ${standing_desk_max_height}
-    on_value:
-      then:
-        lambda: |
-          id(target_desk_height)->traits.set_max_value(x);
-
-button:
-  - platform: restart
-    name: "${friendly_name} Restart"
-
-light:
-  - platform: status_led
-    id: upsy_desky_status_led
-    pin: GPIO23
-    restore_mode: ALWAYS_ON
+  stock: !include stock.yaml

firmware/debug.yaml

@@ -1,5 +1,5 @@
 packages:
-  base: !include config.yaml
+  stock: !include stock.yaml
 
 logger:
   level: DEBUG
@@ -10,4 +10,4 @@ debug:
 text_sensor:
   - platform: debug
     device:
-      name: "${friendly_name} Device Info"
+      name: "Device Info"

firmware/stock.yaml

@@ -0,0 +1,26 @@
+packages:
+  base: !include base.yaml
+
+logger:
+  level: INFO
+
+wifi:
+  ap:
+    password: "hunter2hunter2"
+
+captive_portal:
+
+improv_serial:
+
+api:
+  password: ""
+  reboot_timeout: 0s
+
+web_server:
+  port: 80
+
+ota:
+  password: ""
+
+dashboard_import:
+  package_import_url: github://tjhorner/upsy-desky/firmware/stock.yaml@v0.4.0

pcb/.gitignore

@@ -28,4 +28,6 @@ fp-info-cache
 *.xml
 *.csv
 
-gerbers/
+gerbers/
+
+*auto_saved_files*

pcb/footprints/ASSMANN_A-2004-2-4-LPS-N-R.kicad_mod

@@ -1,6 +1,6 @@
 (footprint "ASSMANN_A-2004-2-4-LPS-N-R" (version 20211014) (generator pcbnew)
   (layer "F.Cu")
-  (tedit 62311021)
+  (tedit 63864A77)
   (attr through_hole)
   (fp_text reference "REF**" (at -4.555 -11.889) (layer "F.SilkS")
     (effects (font (size 1.4 1.4) (thickness 0.15)))
@@ -26,8 +26,8 @@
   (fp_line (start 7.9 -10.3) (end 7.9 8.3) (layer "F.Fab") (width 0.127) (tstamp 9be18c40-130d-4b66-9102-1da4e1c80119))
   (fp_line (start 7.9 8.3) (end -7.9 8.3) (layer "F.Fab") (width 0.127) (tstamp da8e1788-d257-4d54-96d3-98c87df0cc6e))
   (fp_circle (center -8.586 -6.281) (end -8.486 -6.281) (layer "F.Fab") (width 0.2) (fill none) (tstamp a9c8a56e-461b-492b-9749-aebe8a2a8c81))
-  (pad "" np_thru_hole circle (at -5.715 0) (size 3.2 3.2) (drill 3.2) (layers *.Cu *.Mask) (tstamp 6ad6668c-228b-41c6-ba41-b8d810fe2c36))
-  (pad "" np_thru_hole circle (at 5.715 0) (size 3.2 3.2) (drill 3.2) (layers *.Cu *.Mask) (tstamp c370c61a-aa48-4c72-bac6-3715e3d21ea7))
+  (pad "" np_thru_hole circle (at -5.715 0) (size 3 3) (drill 3) (layers F&B.Cu *.Mask) (tstamp 6ad6668c-228b-41c6-ba41-b8d810fe2c36))
+  (pad "" np_thru_hole circle (at 5.715 0) (size 3 3) (drill 3) (layers F&B.Cu *.Mask) (tstamp c370c61a-aa48-4c72-bac6-3715e3d21ea7))
   (pad "1" thru_hole rect (at -4.445 -6.35) (size 1.408 1.408) (drill 0.9) (layers *.Cu *.Mask) (tstamp bf05b196-f692-40f6-810b-c29cb2a69ab8))
   (pad "2" thru_hole circle (at -3.175 -8.89) (size 1.408 1.408) (drill 0.9) (layers *.Cu *.Mask) (tstamp e63b355a-7064-4efd-a5a1-ac83a46530f8))
   (pad "3" thru_hole circle (at -1.905 -6.35) (size 1.408 1.408) (drill 0.9) (layers *.Cu *.Mask) (tstamp d47596a7-7b6b-44f8-b2da-486cb1ae09ed))

pcb/upsy-desky.kicad_pro

@@ -425,7 +425,7 @@
       "workbook_filename": ""
     },
     "page_layout_descr_file": "",
-    "plot_directory": "",
+    "plot_directory": "./",
     "spice_adjust_passive_values": false,
     "spice_external_command": "spice \"%I\"",
     "subpart_first_id": 65,

pcb/upsy-desky.kicad_sch

@@ -4,6 +4,10 @@
 
   (paper "A4")
 
+  (title_block
+    (title "Upsy Desky")
+  )
+
   (lib_symbols
     (symbol "A-2004-2-4-LPS-N-R:A-2004-2-4-LPS-N-R" (pin_names (offset 1.016)) (in_bom yes) (on_board yes)
       (property "Reference" "J" (id 0) (at -5.08 13.97 0)

reversing-firmware/.gitignore

@@ -0,0 +1,5 @@
+# Gitignore settings for ESPHome
+# This is an example and may include too much for your use-case.
+# You can modify this file to suit your needs.
+/.esphome/
+/secrets.yaml

reversing-firmware/README.md

@@ -0,0 +1,11 @@
+# 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://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.
+
+## Customization
+
+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://upsy-desky.tjhorner.dev/docs/reference/gpio/) mapping to see which RJ45 pins correspond to which GPIO pins.

reversing-firmware/config.yaml

@@ -0,0 +1,50 @@
+substitutions:
+  name: "upsy-desky"
+
+esphome:
+  name: "${name}"
+  name_add_mac_suffix: true
+
+esp32:
+  board: esp32dev
+
+logger:
+  level: DEBUG
+
+# UART logging is from the perspective of the handset, i.e.:
+# - TX is the data sent from the handset to the control box
+# - RX is the data sent from the control box to the handset
+uart:
+  - # Direction: Handset -> Control Box
+    id: handset_tx
+    baud_rate: 9600
+    rx_pin: 17
+    debug: &uart_debug
+      direction: RX
+      dummy_receiver: true
+      after:
+        timeout: 50ms
+      sequence:
+        - lambda: UARTDebug::log_hex(uart::UART_DIRECTION_TX, bytes, ':');
+  - # Direction: Control Box -> Handset
+    id: handset_rx
+    baud_rate: 9600
+    rx_pin: 16
+    debug:
+      <<: *uart_debug
+      sequence:
+        - lambda: UARTDebug::log_hex(uart::UART_DIRECTION_RX, bytes, ':');
+
+wifi:
+  ap:
+    password: "hunter2hunter2"
+
+captive_portal:
+
+improv_serial:
+
+web_server:
+  port: 80
+
+ota:
+  password: ""

test-firmware/README.md

@@ -1,6 +1,6 @@
 # Test Firmware
 
-This firmware is used to test assembled boards before shipping. In the future I'd like this process to be more automated but this is what I have for now.
+This firmware is used to test assembled boards before shipping. In the future I'd like this process to be more automated and comprehensive but this is what I have for now.
 
 ## Usage