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

113 lines
2.5 KiB
Plaintext
Raw Normal View History

2022-06-29 08:55:33 -07:00
---
id: user
title: User Configuration
2022-11-02 11:46:54 -07:00
slug: /settings/config/user
2022-06-29 08:55:33 -07:00
sidebar_label: User
---
2023-01-19 05:01:57 -08:00
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
2022-06-29 08:55:33 -07:00
2022-09-23 10:43:46 -07:00
The user config options are: Long Name, Short Name, and Is Licensed. User config uses an admin message sending a `User` protobuf.
2022-06-29 08:55:33 -07:00
## User Config Values
2022-09-23 10:43:46 -07:00
### Long Name
2022-11-02 11:46:54 -07:00
A personalized name for your device.
2022-09-23 10:43:46 -07:00
Auto-generated by default.
If you are a licensed HAM operator and have enabled `IsLicensed`, this should be set to your HAM operator call sign.
2022-06-29 08:55:33 -07:00
### Short Name
2022-09-23 10:43:46 -07:00
A personalized short identifier for your device.
Auto-generated by default.
2022-06-29 08:55:33 -07:00
2022-09-23 10:43:46 -07:00
### Is Licensed (HAM)
2022-06-29 08:55:33 -07:00
If you are a licensed HAM operator and have considered the [privileges and restrictions](/docs/faq/#what-is-the-benefit-of-using-my-ham-license-with-meshtastic) of using Meshtastic with a HAM license, enable this flag.
2022-06-29 08:55:33 -07:00
2022-09-23 10:43:46 -07:00
Disabled by default.
2022-06-29 08:55:33 -07:00
2022-09-23 10:43:46 -07:00
By enabling `IsLicensed`, you should also review the following related configurations:
2022-06-29 08:55:33 -07:00
2022-09-23 10:43:46 -07:00
- **User:** `LongName` (Should be your Call Sign)
- **Channel:** `PSK` (Should be Empty, removing encryption)
2022-06-29 08:55:33 -07:00
<Tabs
groupId="settings"
2022-09-23 10:43:46 -07:00
defaultValue="cli"
2022-06-29 08:55:33 -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-29 08:55:33 -07:00
{label: 'Web', value: 'web'},
]}>
2022-09-23 10:43:46 -07:00
2022-06-29 08:55:33 -07:00
<TabItem value="android">
:::info
2022-12-04 13:15:11 -08:00
2023-01-19 05:01:57 -08:00
User Config options are available for Android.
2022-12-04 13:15:11 -08:00
1. Open the Meshtastic App
2. Navigate to: **Vertical Ellipsis (3 dots top right) > Device Settings > User Config**
2022-06-29 08:55:33 -07:00
:::
</TabItem>
2022-09-23 10:43:46 -07:00
2022-06-29 08:55:33 -07:00
<TabItem value="apple">
:::info
2022-09-23 10:43:46 -07:00
`ShortName` and `LongName` User config options are available on iOS, iPadOS and macOS at `Settings > Radio Configuration > User`.
2022-06-29 08:55:33 -07:00
:::
</TabItem>
2022-09-23 10:43:46 -07:00
2022-06-29 08:55:33 -07:00
<TabItem value="cli">
:::info
2022-09-23 10:43:46 -07:00
All User config options are available in the python CLI. Example commands are below:
:::
2022-10-31 11:13:15 -07:00
Please see instructions for [Enabling HAM License](/docs/software/python/cli/usage#ham-radio-support)
2022-06-29 08:55:33 -07:00
:::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-owner 'your node name' --set-owner-short 'NODE'
```
:::
```shell title="Set the LongName Value"
meshtastic --set-owner 'your node name'
```
```shell title="Set the ShortName Value"
meshtastic --set-owner-short 'NODE'
```
```shell title="Enable Ham Mode, set name to license, disable encryption"
meshtastic --set-ham 'CALLSIGN'
```
2022-06-29 08:55:33 -07:00
</TabItem>
2022-09-23 10:43:46 -07:00
<TabItem value="web">
2022-06-29 08:55:33 -07:00
:::info
2022-09-23 10:43:46 -07:00
All User config options are available in the Web UI.
2022-06-29 08:55:33 -07:00
:::
2022-09-23 10:43:46 -07:00
</TabItem>
2023-01-19 05:01:57 -08:00
</Tabs>