mudhorn/meshtastic
1
0
Fork 0
mirror of https://github.com/meshtastic/meshtastic.git synced 2024-11-13 17:14:25 -08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #702 from pdxlocations/display-config

Browse source 
update screen config documentation
This commit is contained in:
charminULTRA 2023-07-04 23:46:49 -04:00 committed by GitHub
parent 441fe5b53a f83cc1635a
commit dac3d55697
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
docs/configuration/device-config/display.mdx
View file

@ -8,7 +8,7 @@ sidebar_label: Display
import Tabs from "@theme/Tabs"; import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem"; import TabItem from "@theme/TabItem";
The display config options are: Screen On Duration, Auto Carousel Interval, Always Point North and GPS Format. Display config uses an admin message sending a `Config.Display` protobuf. The display config options are: Screen On Duration, Auto Carousel Interval, Always Point North, GPS Format, Preferred Display Units, OLED Definition, Display Mode, Heading Bold, and Wake on Tap or Motion. Display config uses an admin message sending a `Config.Display` protobuf.
## Device Config Values ## Device Config Values
@ -18,7 +18,7 @@ How long the screen remains on after the user button is pressed or messages are
### Auto Carousel Interval ### Auto Carousel Interval
Automatically toggles to the next page on the screen like a carousel, based the specified interval. Automatically toggles to the next page on the screen like a carousel, based on the specified interval.
### Always Point North ### Always Point North
@ -39,15 +39,15 @@ Acceptable values:
| `OLC` | Open Location Code (Plus Codes) | | `OLC` | Open Location Code (Plus Codes) |
| `OSGR` | Ordnance Survey Grid Reference | | `OSGR` | Ordnance Survey Grid Reference |
### Prefered display units ### Preferred Display Units
switch between `METRIC` (default) and `IMPERIAL` units Switch between `METRIC` (default) and `IMPERIAL` units
### Flip Screen ### Flip Screen
If enabled, the screen will be rotated 180 degrees, for cases that mount the screen upside down If enabled, the screen will be rotated 180 degrees, for cases that mount the screen upside down
### OLED Defintion ### OLED Definition
The type of OLED Controller is auto-detected by default, but can be defined with this setting if the auto-detection fails. For the SH1107, we assume a square display with 128x128 Pixels like the GME128128-1. The type of OLED Controller is auto-detected by default, but can be defined with this setting if the auto-detection fails. For the SH1107, we assume a square display with 128x128 Pixels like the GME128128-1.
@ -62,7 +62,7 @@ Acceptable values:
### Display Mode ### Display Mode
The display mode can be set to `NORMAL` (default), `TWOCOLOR` or `INVERTED`. The `TWOCOLOR` mode is intended for OLED displays with the first line of output being a different color than the rest of the display. The `INVERTED` mode will invert that bicolor area, resulting in a white background headline on monochrome displays. The display mode can be set to `DEFAULT` (default), `TWOCOLOR`, `INVERTED` or `COLOR`. The `TWOCOLOR` mode is intended for OLED displays with the first line of output being a different color than the rest of the display. The `INVERTED` mode will invert that bicolor area, resulting in a white background headline on monochrome displays.
### Heading Bold ### Heading Bold
@ -114,12 +114,12 @@ All display config options are available in the python CLI. Example commands are
| --------------------------------- | --------------------------------------------------------- | ----------------------------- | | --------------------------------- | --------------------------------------------------------- | ----------------------------- |
| display.auto_screen_carousel_secs | `integer` | Default of `0` is off. | | display.auto_screen_carousel_secs | `integer` | Default of `0` is off. |
| display.compass_north_top | `false`, `true` | `false` | | display.compass_north_top | `false`, `true` | `false` |
| display.flip_screen | `fasle`, `true` | `false` | | display.flip_screen | `false`, `true` | `false` |
| display.gps_format | `DEC`, `DMS`, `UTM`, `MGRS`, `OLC`, `OSGR` | `DEC` | | display.gps_format | `DEC`, `DMS`, `UTM`, `MGRS`, `OLC`, `OSGR` | `DEC` |
| display.oled | `OLED_AUTO`, `OLED_SSD1306`, `OLED_SH1106`, `OLED_SH1107` | `OLED_AUTO` | | display.oled | `OLED_AUTO`, `OLED_SSD1306`, `OLED_SH1106`, `OLED_SH1107` | `OLED_AUTO` |
| display.screen_on_secs | `integer` | Default of `0` is 10 minutes. | | display.screen_on_secs | `integer` | Default of `0` is 10 minutes. |
| display.units | `METRIC`, `IMPERIAL` | `METRIC` | | display.units | `METRIC`, `IMPERIAL` | `METRIC` |
| display.displaymode | `NORMAL`, `TWOCOLOR`, `INVERTED` | `NORMAL` | | display.displaymode | `DEFAULT`, `TWOCOLOR`, `INVERTED`, `COLOR` | `DEFAULT` |
| display.heading_bold | `false`, `true` | `false` | | display.heading_bold | `false`, `true` | `false` |
| display.wake_on_tap_or_motion | `false`, `true` | `false` | | display.wake_on_tap_or_motion | `false`, `true` | `false` |