Disable bluetooth proxy active connections by default in stock firmware

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,50 @@
+name: Bug Report
+description: File a bug report or get help with an issue.
+labels: ["bug"]
+assignees:
+  - tjhorner
+body:
+  - type: checkboxes
+    id: troubleshooting-followed
+    attributes:
+      label: Troubleshooting Guide
+      description: Please confirm you have followed the [troubleshooting guide](https://upsy-desky.tjhorner.dev/docs/troubleshooting).
+      options:
+        - label: I have followed the steps in the troubleshooting guide and my issue is either not listed or is not solved.
+          required: true
+  - type: textarea
+    id: description
+    attributes:
+      label: Description
+      description: Please describe the bug you encountered, and what you expected to happen instead.
+    validations:
+      required: true
+  - type: textarea
+    id: logs
+    attributes:
+      label: Logs
+      description: Please copy and paste any relevant log output. Learn how to obtain logs [here](https://upsy-desky.tjhorner.dev/docs/troubleshooting/#other-issues).
+      render: plain text
+  - type: input
+    id: config-version
+    attributes:
+      label: Which version of the Upsy Desky firmware config are you running?
+      placeholder: "1.1.1"
+  - type: dropdown
+    id: update-management
+    attributes:
+      label: How do you manage your Upsy Desky's updates?
+      options:
+        - OTA Updates
+        - ESPHome YAML Config
+  - type: input
+    id: esphome-version
+    attributes:
+      label: If you're using an ESPHome YAML config, which version of ESPHome are you running?
+      placeholder: "2023.5.4"
+  - type: textarea
+    id: esphome-config
+    attributes:
+      label: ESPHome Config
+      description: If you have your own ESPHome YAML configuration, please paste it here. Remember to redact any sensitive information like encryption keys or passwords.
+      render: YAML

.github/workflows/nightly-build.yaml

@@ -0,0 +1,40 @@
+name: Nightly Stock Firmware Build
+on:
+  schedule:
+    - cron: "0 0 * * *"
+
+jobs:
+  build:
+    name: Build Firmware
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: actions/setup-python@v2
+        with:
+          python-version: "3.9"
+
+      - name: Install ESPHome
+        run: pip install --user esphome
+      
+      - name: Compile Release Firmware
+        working-directory: firmware
+        run: |
+          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
+
+      - uses: actions/upload-artifact@v3
+        with:
+          name: firmware-bin
+          path: firmware/bin
+
+      - name: Send Discord failure notification
+        if: failure()
+        uses: appleboy/discord-action@master
+        with:
+          webhook_id: ${{ secrets.DISCORD_WEBHOOK_ID }}
+          webhook_token: ${{ secrets.DISCORD_WEBHOOK_TOKEN }}
+          color: "#FF6961"
+          message: "The latest nightly build failed: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}"

README.md

@@ -46,10 +46,7 @@ Or whatever else you'd like. The possibilities are endless! As long as the possi
 
 ## Compatibility
 
-Any standing desk that uses RJ45 to connect to the keypad is likely compatible, but these brands of desks have been verified to work, with official firmware provided:
-
-- UPLIFT v2
-- Fully Jarvis
+Any standing desk that uses RJ45 to connect to the keypad is likely compatible, but the control boxes listed [here](https://upsy-desky.tjhorner.dev/docs/reference/compatibility/) are verified to be compatible.
 
 ## Documentation
 

firmware/README.md

@@ -13,4 +13,6 @@ It is organized like so:
 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)
+- `runtime-config.yaml`: Adds support for runtime configuration options (you might want to remove this if you are configuring everything via ESPHome yaml)
+- `bluetooth-proxy.yaml`: Contains the necessary configuration to use the Upsy Desky as a [Bluetooth Proxy](https://esphome.io/components/bluetooth_proxy.html)
+- `stable-ids.yaml`: Contains configuration necessary to keep some entity IDs stable via the HTTP API

firmware/addons/bluetooth-proxy.yaml

@@ -0,0 +1,7 @@
+substitutions:
+  bluetooth_proxy_active_connections: "true"
+
+esp32_ble_tracker:
+
+bluetooth_proxy:
+  active: ${bluetooth_proxy_active_connections}

firmware/addons/presets.yaml

@@ -23,7 +23,7 @@ button:
   # Recall Presets
   - platform: template
     id: recall_preset_1
-    name: "${friendly_name} Preset 1"
+    name: "Preset 1"
     icon: "mdi:numeric-1-box"
     on_press:
       - output.turn_on: button_bit1
@@ -34,7 +34,7 @@ button:
 
   - platform: template
     id: recall_preset_2
-    name: "${friendly_name} Preset 2"
+    name: "Preset 2"
     icon: "mdi:numeric-2-box"
     on_press:
       - output.turn_on: button_bit4
@@ -43,7 +43,7 @@ button:
 
   - platform: template
     id: recall_preset_3
-    name: "${friendly_name} Preset 3"
+    name: "Preset 3"
     icon: "mdi:numeric-3-box"
     on_press:
       - output.turn_on: button_bit2
@@ -54,7 +54,7 @@ button:
 
   - platform: template
     id: recall_preset_4
-    name: "${friendly_name} Preset 4"
+    name: "Preset 4"
     icon: "mdi:numeric-4-box"
     on_press:
       - output.turn_on: button_bit4
@@ -65,7 +65,7 @@ button:
 
   # Set Presets
   - platform: template
-    name: "${friendly_name} Set Preset 1"
+    name: "Set Preset 1"
     entity_category: "config"
     icon: "mdi:numeric-1-box-multiple"
     on_press:
@@ -75,7 +75,7 @@ button:
       - button.press: recall_preset_1
 
   - platform: template
-    name: "${friendly_name} Set Preset 2"
+    name: "Set Preset 2"
     entity_category: "config"
     icon: "mdi:numeric-2-box-multiple"
     on_press:
@@ -85,7 +85,7 @@ button:
       - button.press: recall_preset_2
 
   - platform: template
-    name: "${friendly_name} Set Preset 3"
+    name: "Set Preset 3"
     entity_category: "config"
     icon: "mdi:numeric-3-box-multiple"
     on_press:
@@ -95,7 +95,7 @@ button:
       - button.press: recall_preset_3
 
   - platform: template
-    name: "${friendly_name} Set Preset 4"
+    name: "Set Preset 4"
     entity_category: "config"
     icon: "mdi:numeric-4-box-multiple"
     on_press:

firmware/addons/runtime-config.yaml

@@ -1,19 +1,7 @@
 select:
   - platform: template
-    name: "${friendly_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: "${friendly_name} Height Units"
+    id: height_units_config
+    name: "Height Units"
     entity_category: "config"
     optimistic: true
     restore_value: true
@@ -24,12 +12,24 @@ select:
     on_value:
       then:
         lambda: |
-          id(desk_height)->set_unit_of_measurement(x);
-          id(target_desk_height)->traits.set_unit_of_measurement(x);
+          const char *unit = id(height_units_config)->state.c_str();
+          id(desk_height)->set_unit_of_measurement(unit);
+          id(target_desk_height)->traits.set_unit_of_measurement(unit);
+
+button:
+  - platform: template
+    name: "Re-Detect Decoder"
+    entity_category: "config"
+    icon: "mdi:cog-refresh"
+    on_press:
+      - uart.write:
+          id: handset_tx
+          data: [ 0x0 ]
+      - standing_desk_height.detect_decoder: desk_height
 
 number:
   - platform: template
-    name: "${friendly_name} Min Target Height"
+    name: "Min Target Height"
     entity_category: "config"
     min_value: 0
     max_value: 150
@@ -42,7 +42,7 @@ number:
         lambda: |
           id(target_desk_height)->traits.set_min_value(x);
   - platform: template
-    name: "${friendly_name} Max Target Height"
+    name: "Max Target Height"
     entity_category: "config"
     min_value: 0
     max_value: 150

firmware/base.yaml

@@ -1,7 +1,9 @@
 # Essential ESPHome config options
 esphome:
   name: "${name}"
+  friendly_name: "${friendly_name}"
   name_add_mac_suffix: true
+  min_version: "2023.5.1"
   on_boot:
     then:
       # Wakes up the desk and reports height
@@ -10,7 +12,7 @@ esphome:
           data: [ 0x0 ]
   project:
     name: tj_horner.upsy_desky
-    version: "0.3.1"
+    version: "1.2.0"
 
 uart:
   id: handset_tx
@@ -24,14 +26,13 @@ esp32:
 substitutions:
   name: "upsy-desky"
   friendly_name: "Upsy Desky"
-  desk_height_name: "${friendly_name} Desk Height"
-  target_desk_height_name: "${friendly_name} Target Desk Height"
+  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"
 
@@ -45,18 +46,18 @@ substitutions:
   default_height_units: "in" # Must be "in" or "cm"
 
 packages:
-  standing_desk: github://tjhorner/esphome-standing-desk/configs/template.yaml@master
+  standing_desk: github://tjhorner/esphome-standing-desk/configs/template.yaml
   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: "${friendly_name} Restart"
+    name: "Restart"
 
 light:
   - platform: status_led
     id: upsy_desky_status_led
-    name: "${friendly_name} Status LED"
+    name: "Status LED"
     pin: GPIO23
     restore_mode: RESTORE_DEFAULT_ON

firmware/debug.yaml

@@ -10,4 +10,4 @@ debug:
 text_sensor:
   - platform: debug
     device:
-      name: "${friendly_name} Device Info"
+      name: "Device Info"

firmware/stock.yaml

@@ -1,5 +1,18 @@
 packages:
   base: !include base.yaml
+  addon_bluetooth_proxy: !include addons/bluetooth-proxy.yaml
+
+substitutions:
+  bluetooth_proxy_active_connections: "false"
+
+external_components:
+  - source: github://tjhorner/esphome-custom-components
+    components: [ project_version ]
+
+text_sensor:
+  - platform: project_version
+    name: "Upsy Desky Firmware Version"
+    internal: true
 
 logger:
   level: INFO
@@ -12,15 +25,18 @@ captive_portal:
 
 improv_serial:
 
+esp32_improv:
+  authorizer: false
+
 api:
-  password: ""
   reboot_timeout: 0s
 
 web_server:
   port: 80
+  js_url: "https://upsy-desky.tjhorner.dev/esphome-webserver/www.js"
 
 ota:
   password: ""
 
 dashboard_import:
-  package_import_url: github://tjhorner/upsy-desky/firmware/stock.yaml@v0.3.1
+  package_import_url: github://tjhorner/upsy-desky/firmware/stock.yaml@v1.1.1

pcb/upsy-desky.kicad_pro

@@ -1,5 +1,6 @@
 {
   "board": {
+    "3dviewports": [],
     "design_settings": {
       "defaults": {
         "board_outline_line_width": 0.09999999999999999,
@@ -138,7 +139,8 @@
       "zones_allow_external_fillets": false,
       "zones_use_no_outline": true
     },
-    "layer_presets": []
+    "layer_presets": [],
+    "viewports": []
   },
   "boards": [],
   "cvpcb": {
@@ -322,18 +324,23 @@
     "rule_severities": {
       "bus_definition_conflict": "error",
       "bus_entry_needed": "error",
-      "bus_label_syntax": "error",
       "bus_to_bus_conflict": "error",
       "bus_to_net_conflict": "error",
+      "conflicting_netclasses": "error",
       "different_unit_footprint": "error",
       "different_unit_net": "error",
       "duplicate_reference": "error",
       "duplicate_sheet_names": "error",
+      "endpoint_off_grid": "warning",
       "extra_units": "error",
       "global_label_dangling": "warning",
       "hier_label_mismatch": "error",
       "label_dangling": "error",
       "lib_symbol_issues": "warning",
+      "missing_bidi_pin": "warning",
+      "missing_input_pin": "warning",
+      "missing_power_pin": "error",
+      "missing_unit": "warning",
       "multiple_net_names": "warning",
       "net_not_bus_member": "warning",
       "no_connect_connected": "warning",
@@ -343,6 +350,7 @@
       "pin_to_pin": "warning",
       "power_pin_not_driven": "error",
       "similar_labels": "warning",
+      "simulation_model_issue": "error",
       "unannotated": "error",
       "unit_value_mismatch": "error",
       "unresolved_variable": "error",
@@ -360,7 +368,7 @@
   "net_settings": {
     "classes": [
       {
-        "bus_width": 12.0,
+        "bus_width": 12,
         "clearance": 0.2,
         "diff_pair_gap": 0.25,
         "diff_pair_via_gap": 0.25,
@@ -374,13 +382,15 @@
         "track_width": 0.25,
         "via_diameter": 0.8,
         "via_drill": 0.4,
-        "wire_width": 6.0
+        "wire_width": 6
       }
     ],
     "meta": {
-      "version": 2
+      "version": 3
     },
-    "net_colors": null
+    "net_colors": null,
+    "netclass_assignments": null,
+    "netclass_patterns": []
   },
   "pcbnew": {
     "last_paths": {
@@ -396,6 +406,8 @@
   "schematic": {
     "annotate_start_num": 0,
     "drawing": {
+      "dashed_lines_dash_length_ratio": 12.0,
+      "dashed_lines_gap_length_ratio": 3.0,
       "default_line_thickness": 6.0,
       "default_text_size": 50.0,
       "field_names": [],
@@ -427,7 +439,11 @@
     "page_layout_descr_file": "",
     "plot_directory": "./",
     "spice_adjust_passive_values": false,
+    "spice_current_sheet_as_root": false,
     "spice_external_command": "spice \"%I\"",
+    "spice_model_current_sheet_as_root": true,
+    "spice_save_all_currents": false,
+    "spice_save_all_voltages": false,
     "subpart_first_id": 65,
     "subpart_id_separator": 0
   },

tools/README.md

@@ -0,0 +1,9 @@
+# Tools
+
+## `oem-flash.sh`
+
+This script is used before shipment to flash the Upsy Desky with the stock firmware, and to reprogram the CP2102 USB-to-serial chip with the correct name and serial (based on MAC address).
+
+## `test-flash.sh`
+
+Flashes the test firmware with PlatformIO (see `../test-firmware`).

tools/oem-flash.sh

@@ -0,0 +1,12 @@
+#!/bin/bash
+
+MAC_ADDR=$(esptool.py --chip esp32 read_mac | sed -En "s/MAC: (.*)/\1/p" | uniq | sed 's/://g')
+esphome upload --device /dev/cu.usbserial* ../firmware/stock.yaml
+
+if ! command -v cp210x-cfg &> /dev/null
+then
+  # Get cp210x-cfg from https://github.com/DiUS/cp210x-cfg
+  echo "cp210x-cfg was not found; CP2102 will not be serialized or renamed"
+else
+  cp210x-cfg -N "Upsy Desky" -S $MAC_ADDR
+fi

tools/test-flash.sh

@@ -0,0 +1,2 @@
+#!/bin/bash
+platformio run -d ../test-firmware --target upload --environment test_target

tools/tindie/.gitignore

@@ -0,0 +1 @@
+*.csv

tools/tindie/split-csv.sh

@@ -0,0 +1,26 @@
+#!/bin/bash
+
+rm -f ud_orders.csv first_class_and_intl.csv priority.csv priority_express.csv pickup.csv
+
+csvq -o ud_orders.csv "SELECT * FROM all_orders WHERE \`Model Number\` LIKE \"%UPSY%\";"
+
+csvq -o first_class_and_intl.csv "SELECT * FROM ud_orders WHERE \`Shipping Method\` LIKE \"%First-Class%\" OR \`Shipping Method\` LIKE \"%Simple Export Rate%\";"
+csvq -o priority.csv "SELECT * FROM ud_orders WHERE \`Shipping Method\` LIKE \"%Priority Mail%\" AND \`Shipping Method\` NOT LIKE \"%Priority Mail Express%\";"
+csvq -o priority_express.csv "SELECT * FROM ud_orders WHERE \`Shipping Method\` LIKE \"%Priority Mail Express%\";"
+csvq -o pickup.csv "SELECT * FROM ud_orders WHERE \`Shipping Method\` LIKE \"%Pickup%\";"
+
+SANITY_CHECK_QUERY=$(cat <<-END
+  SELECT
+    (SELECT count(*) from ud_orders)
+      =
+    (
+      (SELECT count(*) from first_class_and_intl) +
+      (SELECT count(*) from priority) +
+      (SELECT count(*) from priority_express) +
+      (SELECT count(*) from pickup)
+    )
+  AS SanityCheck;
+END
+)
+
+csvq "$SANITY_CHECK_QUERY"