mirror of
https://github.com/meshtastic/meshtastic.git
synced 2024-11-16 10:34:14 -08:00
160 lines
5.9 KiB
Plaintext
160 lines
5.9 KiB
Plaintext
---
|
|
id: display
|
|
title: Display Configuration
|
|
slug: /settings/config/display
|
|
sidebar_label: Display
|
|
---
|
|
|
|
import Tabs from "@theme/Tabs";
|
|
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.
|
|
|
|
## Device Config Values
|
|
|
|
### Screen On Duration
|
|
|
|
How long the screen remains on after the user button is pressed or messages are received.
|
|
|
|
### Auto Carousel Interval
|
|
|
|
Automatically toggles to the next page on the screen like a carousel, based the specified interval.
|
|
|
|
### Always Point North
|
|
|
|
If this is set, the compass heading on the screen outside of the circle will always point north. This feature is off by default and the top of display represents your heading direction, the North indicator will move around the circle.
|
|
|
|
### GPS Format
|
|
|
|
The format used to display GPS coordinates on the device screen.
|
|
|
|
Acceptable values:
|
|
|
|
| Value | Description |
|
|
| :----: | :-----------------------------: |
|
|
| `DEC` | Decimal Degrees |
|
|
| `DMS` | Degrees Minutes Seconds |
|
|
| `UTM` | Universal Transverse Mercator |
|
|
| `MGRS` | Military Grid Reference System |
|
|
| `OLC` | Open Location Code (Plus Codes) |
|
|
| `OSGR` | Ordnance Survey Grid Reference |
|
|
|
|
### Prefered display units
|
|
|
|
switch between `METRIC` (default) and `IMPERIAL` units
|
|
|
|
### Flip Screen
|
|
|
|
If enabled, the screen will be rotated 180 degrees, for cases that mount the screen upside down
|
|
|
|
### OLED Defintion
|
|
|
|
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.
|
|
|
|
Acceptable values:
|
|
|
|
| Value | Description |
|
|
| :------------: | :-----------------------------------------: |
|
|
| `OLED_AUTO` | Auto detect display controller |
|
|
| `OLED_SSD1306` | Always use SSD1306 driver |
|
|
| `OLED_SH1106` | Always use SH1106 driver |
|
|
| `OLED_SH1107` | Always use SH1107 driver (Geometry 128x128) |
|
|
|
|
### 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.
|
|
|
|
### Heading Bold
|
|
|
|
The heading can be hard to read when 'INVERTED' or 'TWOCOLOR' display mode is used. This setting will make the heading bold, so it is easier to read.
|
|
|
|
### Wake on Tap or Motion
|
|
|
|
This option enables the ability to wake the device screen when motion, such as a tap on the device, is detected via an attached accelerometer.
|
|
|
|
## Device Config Client Availability
|
|
|
|
<Tabs
|
|
groupId="settings"
|
|
defaultValue="apple"
|
|
values={[
|
|
{label: 'Android', value: 'android'},
|
|
{label: 'Apple', value: 'apple'},
|
|
{label: 'CLI', value: 'cli'},
|
|
{label: 'Web', value: 'web'},
|
|
]}>
|
|
<TabItem value="android">
|
|
|
|
:::info
|
|
|
|
Display Config is available for Android.
|
|
|
|
1. Open the Meshtastic App
|
|
2. Navigate to: **Vertical Ellipsis (3 dots top right) > Device Settings > Display Config**
|
|
|
|
:::
|
|
|
|
</TabItem>
|
|
<TabItem value="apple">
|
|
|
|
:::info
|
|
All display config options are available on iOS, iPadOS and macOS at Settings > Radio Configuration > Display.
|
|
:::
|
|
|
|
</TabItem>
|
|
<TabItem value="cli">
|
|
|
|
:::info
|
|
|
|
All display config options are available in the python CLI. Example commands are below:
|
|
|
|
:::
|
|
|
|
| Setting | Acceptable Values | Default |
|
|
| --------------------------------- | --------------------------------------------------------- | ----------------------------- |
|
|
| display.auto_screen_carousel_secs | `integer` | Default of `0` is off. |
|
|
| display.compass_north_top | `false`, `true` | `false` |
|
|
| display.flip_screen | `fasle`, `true` | `false` |
|
|
| display.gps_format | `DEC`, `DMS`, `UTM`, `MGRS`, `OLC`, `OSGR` | `DEC` |
|
|
| display.oled | `OLED_AUTO`, `OLED_SSD1306`, `OLED_SH1106`, `OLED_SH1107` | `OLED_AUTO` |
|
|
| display.screen_on_secs | `integer` | Default of `0` is 10 minutes. |
|
|
| display.units | `METRIC`, `IMPERIAL` | `METRIC` |
|
|
| display.displaymode | `NORMAL`, `TWOCOLOR`, `INVERTED` | `NORMAL` |
|
|
| display.heading_bold | `false`, `true` | `false` |
|
|
| display.wake_on_tap_or_motion | `false`, `true` | `false` |
|
|
|
|
:::tip
|
|
|
|
Because the device will reboot after each command is sent via CLI, it is recommended when setting multiple values in a config section that commands be chained together as one.
|
|
|
|
```shell title="Example:"
|
|
meshtastic --set display.screen_on_secs 120 --set display.gps_format UTM
|
|
```
|
|
|
|
:::
|
|
|
|
```shell title="Set Screen On Duration (Default of 0 is 10 minutes)"
|
|
meshtastic --set display.screen_on_secs 0
|
|
meshtastic --set display.screen_on_secs 120
|
|
```
|
|
|
|
```shell title="Set Auto Carousel Interval (Default of 0 is Off)"
|
|
meshtastic --set display.auto_screen_carousel_secs 0
|
|
// Set to 2 Minutes (120 Seconds)
|
|
meshtastic --set display.auto_screen_carousel_secs 120
|
|
```
|
|
|
|
```shell title="Specify GPS format on device screen"
|
|
meshtastic --set display.gps_format UTM
|
|
```
|
|
|
|
</TabItem>
|
|
<TabItem value="web">
|
|
|
|
:::info
|
|
All display config options are available in the Web UI.
|
|
:::
|
|
|
|
</TabItem>
|
|
</Tabs>
|