meshtastic/docs/configuration/device-config/display.mdx
2022-11-03 20:10:08 -04:00

102 lines
2.7 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 |
| :-------: | :--------------------------: |
| `gpsFormatDec` | Decimal Degrees |
| `gpsFormatDms` | Degrees Minutes Seconds |
| `gpsFormatUtm` | Universal Transverse Mercator |
| `gpsFormatMgrs` | Military Grid Reference System |
| `gpsFormatOlc` | Open Location Code (Plus Codes) |
| `gpsFormatOsgr` | Ordnance Survey Grid Reference |
## Device Config Client Availability
<Tabs
groupId="settings"
defaultValue="apple"
values={[
{label: 'Android', value: 'android'},
{label: 'Apple', value: 'apple'},
{label: 'CLI', value: 'cli'},
{label: 'Flasher', value: 'flasher'},
{label: 'Web', value: 'web'},
]}>
<TabItem value="android">
:::info
Display config is not available for Android.
:::
</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">
All display config options are available in the python CLI. Example commands are below:
```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 GpsFormatUTM
```
</TabItem>
<TabItem value="flasher">
:::info
No display config options are available in the Flasher.
:::
</TabItem>
<TabItem value="web">
:::info
All display config options are available in the Web UI.
:::
</TabItem>
</Tabs>