j/armchair_fw
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README: Add Quickstart, Add new chairAdjust method to Usage

Browse Source
This commit is contained in:
jonny 2024-09-08 14:50:42 +02:00
parent 25cc72c5e6
commit 3890fc5e8d
1 changed files with 35 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
README.md
View File

@ -46,7 +46,7 @@ The projects in the folders `board_control/` and `board_motorctl/` are no longer
- **Electric Chair Adjustment:** Control 4 Relays powering motors that adjust the chair rest positions - **Electric Chair Adjustment:** Control 4 Relays powering motors that adjust the chair rest positions
- **Wi-Fi:** - **Wi-Fi:**
- Hosts wireless network - Hosts wireless network
- Webserver with webroot in SPIFFS - Web server with webroot in SPIFFS
- HTTP API for controlling the chair (remote control) - HTTP API for controlling the chair (remote control)
- **React web-app:** Virtual joystick sending data to http-API (placed in SPIFFS) - **React web-app:** Virtual joystick sending data to http-API (placed in SPIFFS)
@ -83,7 +83,7 @@ For more details refer to the documentation on the [website](https://pfusch.zone
A custom pcb with relays and protection for controlling the 2 motors that adjust the rest positions of the armchair was created in this repository as well: A custom pcb with relays and protection for controlling the 2 motors that adjust the rest positions of the armchair was created in this repository as well:
Date: 2024.09.08 Date: 2024.09.08
Folder: [hardware/chairAdjust-relayBoard](hardware/chairAdjust-relayBoard) Folder: [hardware/chairAdjust-relayBoard](hardware/chairAdjust-relayBoard)
Schematic: [hardware/chciairAdjust-relayBoard/export/schematic.pdf](hardware/chairAdjust-relayBoard/export/schematic.pdf) Schematic: [hardware/chairAdjust-relayBoard/export/schematic.pdf](hardware/chairAdjust-relayBoard/export/schematic.pdf)
<br> <br>
<br> <br>
<p align="center"> <p align="center">
@ -174,13 +174,37 @@ idf.py monitor
# Usage / User Interface # Usage / User Interface
## Encoder Functions ## Quickstart
- **Browse / select any mode**
- `[long press]` opens menu for selecting the desired mode (*JOYSTICK* for driving)
- **Driving**
- `[3x click]` enters *JOYSTICK* mode
- **Rest position**
- `[rotate]` adjusts the leg rest position
- `[press + rotate]` at the same time: adjusts the back rest position
- alternatively enter *ADJUST* mode and control rests via joystick
**When not in MENU mode**, the button (encoder click) has the following functions: <br>
## Encoder Functions
- *When not in MENU mode*, **rotating the encoder** has the following functions:
| Encoder Event | Action |
|---------------------|---------------------------|
| rotate left | Move leg rest up by 10% |
| rotate right | Move leg rest DOWN by 10% |
| press + rotate left | Move back rest down by 5% |
| press + rotate left | Move back rest up by 5% |
Note: first tick is ignored -> quickly rotate 2 ticks at first
<br>
- *When not in MENU mode*, **clicking the encoder** has the following functions:
| Count | Type | Action | Description | | Count | Type | Action | Description |
|-------|---------------|----------------------|---------------------------------------------------------------------------------------------| |-------|---------------|----------------------|---------------------------------------------------------------------------------------------|
| 1x long | switch mode | **MENU_MODE_SELECT** | Open menu for selecting the current control mode | | 1x long | switch mode | **MENU_MODE_SELECT** | Open **menu for selecting the current control mode** |
| 1x | control | [MASSAGE] **freeze** input | When in massage mode: lock or unlock joystick input at current position. | | 1x | control | [MASSAGE] **freeze** input | When in massage mode: lock or unlock joystick input at current position. |
| 1x short, 1x long | switch mode | **ADJUST-CHAIR** | Switch to mode where the armchair leg and backrest are controlled via joystick. | | 1x short, 1x long | switch mode | **ADJUST-CHAIR** | Switch to mode where the armchair leg and backrest are controlled via joystick. |
| 2x | toggle mode | **IDLE** <=> previous| Enable/disable chair armchair (e.g., enable after startup or switch to previous mode after timeout). | | 2x | toggle mode | **IDLE** <=> previous| Enable/disable chair armchair (e.g., enable after startup or switch to previous mode after timeout). |
@ -192,7 +216,10 @@ idf.py monitor
| 8x | toggle option| **deceleration limit** | Disable/enable deceleration limit (default on) => more responsive. | | 8x | toggle option| **deceleration limit** | Disable/enable deceleration limit (default on) => more responsive. |
| 12x | toggle option| **alt stick mapping** | Toggle between default and alternative stick mapping (reverse direction swapped). | | 12x | toggle option| **alt stick mapping** | Toggle between default and alternative stick mapping (reverse direction swapped). |
**When in MENU_SETTINGS mode** (5x click), the encoder controls the settings menu: (similar in MENU_MODE_SELECT)
<br>
- When in **MENU_SETTINGS mode** (5x click), the encoder controls the settings menu: (similar in MENU_MODE_SELECT)
| Encoder Event | Current Menu | Action | | Encoder Event | Current Menu | Action |
|---------------|--------------|--------------------------------------------------------------| |---------------|--------------|--------------------------------------------------------------|
@ -203,6 +230,8 @@ idf.py monitor
| rotate | main-menu | Scroll through menu items. | | rotate | main-menu | Scroll through menu items. |
| rotate | value-select | Change value. | | rotate | value-select | Change value. |
<br>
## HTTP Mode ## HTTP Mode
Control the armchair via a virtual joystick on the web interface. Control the armchair via a virtual joystick on the web interface.