Version 1.1.0

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,4 @@
+esp32_ble_tracker:
+
+bluetooth_proxy:
+  active: true

firmware/addons/runtime-config.yaml

@@ -1,18 +1,6 @@
 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
+    id: height_units_config
     name: "Height Units"
     entity_category: "config"
     optimistic: true
@@ -24,8 +12,20 @@ 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

firmware/base.yaml

@@ -3,6 +3,7 @@ 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
@@ -11,7 +12,7 @@ esphome:
           data: [ 0x0 ]
   project:
     name: tj_horner.upsy_desky
-    version: "0.4.0"
+    version: "1.1.0"
 
 uart:
   id: handset_tx
@@ -32,7 +33,6 @@ substitutions:
   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"
 
@@ -46,10 +46,11 @@ 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
+  addon_bluetooth_proxy: !include addons/bluetooth-proxy.yaml
 
 button:
   - platform: restart

firmware/components/.gitignore

@@ -0,0 +1 @@
+**/__pycache__

firmware/components/project_version/project_version_text_sensor.cpp

@@ -0,0 +1,19 @@
+#include "project_version_text_sensor.h"
+#include "esphome/core/log.h"
+#include "esphome/core/application.h"
+#include "esphome/core/version.h"
+
+namespace esphome {
+namespace project_version {
+
+static const char *const TAG = "project_version.text_sensor";
+
+void ProjectVersionTextSensor::setup() {
+  this->publish_state(ESPHOME_PROJECT_VERSION);
+}
+float ProjectVersionTextSensor::get_setup_priority() const { return setup_priority::DATA; }
+std::string ProjectVersionTextSensor::unique_id() { return get_mac_address() + "-project-version"; }
+void ProjectVersionTextSensor::dump_config() { LOG_TEXT_SENSOR("", "Project Version Text Sensor", this); }
+
+}  // namespace version
+}  // namespace esphome

firmware/components/project_version/project_version_text_sensor.h

@@ -0,0 +1,18 @@
+#pragma once
+
+#include "esphome/core/component.h"
+#include "esphome/components/text_sensor/text_sensor.h"
+
+namespace esphome {
+namespace project_version {
+
+class ProjectVersionTextSensor : public text_sensor::TextSensor, public Component {
+ public:
+  void setup() override;
+  void dump_config() override;
+  float get_setup_priority() const override;
+  std::string unique_id() override;
+};
+
+}  // namespace version
+}  // namespace esphome

firmware/components/project_version/text_sensor.py

@@ -0,0 +1,31 @@
+import esphome.codegen as cg
+import esphome.config_validation as cv
+from esphome.components import text_sensor
+from esphome.const import (
+    ENTITY_CATEGORY_DIAGNOSTIC,
+    ICON_NEW_BOX,
+)
+
+project_version = cg.esphome_ns.namespace("project_version")
+ProjectVersionTextSensor = project_version.class_(
+    "ProjectVersionTextSensor", text_sensor.TextSensor, cg.Component
+)
+
+CONFIG_SCHEMA = (
+    text_sensor.text_sensor_schema(
+        icon=ICON_NEW_BOX,
+        entity_category=ENTITY_CATEGORY_DIAGNOSTIC,
+    )
+    .extend(
+        {
+            cv.GenerateID(): cv.declare_id(ProjectVersionTextSensor),
+        }
+    )
+    .extend(cv.COMPONENT_SCHEMA)
+)
+
+
+async def to_code(config):
+    var = await text_sensor.new_text_sensor(config)
+    await cg.register_component(var, config)
+

firmware/stock.yaml

@@ -1,6 +1,15 @@
 packages:
   base: !include base.yaml
 
+external_components:
+  - source: ./components
+    components: [ project_version ]
+
+text_sensor:
+  - platform: project_version
+    name: "Upsy Desky Firmware Version"
+    internal: true
+
 logger:
   level: INFO
 
@@ -13,7 +22,6 @@ captive_portal:
 improv_serial:
 
 api:
-  password: ""
   reboot_timeout: 0s
 
 web_server:
@@ -23,4 +31,4 @@ ota:
   password: ""
 
 dashboard_import:
-  package_import_url: github://tjhorner/upsy-desky/firmware/stock.yaml@v0.4.0
+  package_import_url: github://tjhorner/upsy-desky/firmware/stock.yaml@v1.1.0

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"