Skip to content

Commit

Permalink
clarify how to interpret numbers in device profile JSON
Browse files Browse the repository at this point in the history
  • Loading branch information
schlimmchen committed Sep 21, 2024
1 parent 7ea6ee0 commit d7af8bb
Showing 1 changed file with 13 additions and 4 deletions.
17 changes: 13 additions & 4 deletions docs/firmware/device_profiles.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,19 @@ the respective parameters. If any parameter is not set, the default value `-1`

## Structure of the JSON file

!!!note "GPIO Numbers"
Please be aware that the numerical values used in the device profile JSON
file are **ESP32 chip GPIO numbers** (NOT physical pin numbers). Refer to
the documentation of your respective ESP32 board to learn at what physical
pin header a particular ESP32 GPIO is available.

!!!warning "GPIO Numbering on different chips"
Some GPIO numbers available on one particular chip may be unavailable on
another. Keep this in mind when upgrading, e.g., from an ESP32 to an
ESP32-S3. Also, different boards may expose different GPIOs on their
respective pin headers. Always check which GPIOs are actually available on
your board before choosing which GPIOs to use.

!!!note "Examples"
These profiles are partially incomplete and merely serve as example snippets.

Expand Down Expand Up @@ -171,10 +184,6 @@ the respective parameters. If any parameter is not set, the default value `-1`
]
```

!!! note "Note"
Please be aware that numerical values used in the profile `.json` file are
**ESP chip GPIO numbers** (NOT physical Pin numbers).

## Implemented configuration values

| Parameter | Data Type | Description |
Expand Down

0 comments on commit d7af8bb

Please sign in to comment.