meshtastic/docs/configuration/device-config/display.mdx

116 lines
3.2 KiB
Plaintext
Raw Normal View History

2022-06-24 19:40:15 -07:00
---
id: display
title: Display Configuration
2022-11-02 11:46:54 -07:00
slug: /settings/config/display
2022-06-24 19:40:15 -07:00
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.
2022-06-24 19:40:15 -07:00
## 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.
2022-06-24 19:40:15 -07:00
### GPS Format
The format used to display GPS coordinates on the device screen.
Acceptable values:
| Value | Description |
| :-------: | :--------------------------: |
2022-11-09 01:50:40 -08:00
| `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.
Acceptable values:
| Value | Description |
| :-------: | :--------------------------: |
| `OLED_AUTO` | Auto detect display controller |
| `OLED_SSD1306` | Always use SSD1306 driver |
| `OLED_SH1106` | Always use SH1106 driver |
2022-06-24 19:40:15 -07:00
## Device Config Client Availability
<Tabs
groupId="settings"
defaultValue="apple"
2022-06-24 19:40:15 -07:00
values={[
{label: 'Android', value: 'android'},
{label: 'Apple', value: 'apple'},
2022-06-29 22:33:26 -07:00
{label: 'CLI', value: 'cli'},
2022-06-24 19:40:15 -07:00
{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">
2022-08-03 08:14:18 -07:00
All display config options are available in the python CLI. Example commands are below:
2022-06-24 19:40:15 -07:00
```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
2022-06-24 19:40:15 -07:00
```
```shell title="Set Auto Carousel Interval (Default of 0 is Off)"
2022-09-29 06:08:51 -07:00
meshtastic --set display.auto_screen_carousel_secs 0
// Set to 2 Minutes (120 Seconds)
meshtastic --set display.auto_screen_carousel_secs 120
2022-06-24 19:40:15 -07:00
```
```shell title="Specify GPS format on device screen"
2022-11-09 01:50:40 -08:00
meshtastic --set display.gps_format UTM
2022-06-24 19:40:15 -07:00
```
</TabItem>
<TabItem value="flasher">
:::info
2022-07-11 11:05:10 -07:00
No display config options are available in the Flasher.
2022-06-24 19:40:15 -07:00
:::
</TabItem>
<TabItem value="web">
:::info
All display config options are available in the Web UI.
2022-06-24 19:40:15 -07:00
:::
</TabItem>
2022-09-29 06:08:51 -07:00
</Tabs>