meshtastic/docs/settings/config/user.mdx
2022-09-30 09:43:26 -07:00

102 lines
2.2 KiB
Plaintext

---
id: user
title: User Configuration
sidebar_label: User
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
The user config options are: Long Name, Short Name, and Is Licensed. User config uses an admin message sending a `User` protobuf.
## User Config Values
### Long Name
A personalised name for your device.
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.
### Short Name
A personalized short identifier for your device.
Auto-generated by default.
### Is Licensed (HAM)
If you are a licensed HAM operator and have considered the [privileges and restrictions](/docs/faq/ham#what-is-the-benefit-of-using-my-ham-license-with-meshtastic) of using Meshtastic with a HAM license, enable this flag.
Disabled by default.
By enabling `IsLicensed`, you should also review the following related configurations:
- **User:** `LongName` (Should be your Call Sign)
- **Channel:** `PSK` (Should be Empty, removing encryption)
<Tabs
groupId="settings"
defaultValue="cli"
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
`LongName` can be edited on Android.
:::
</TabItem>
<TabItem value="apple">
:::info
`ShortName` and `LongName` User config options are available on iOS, iPadOS and macOS at `Settings > Radio Configuration > User`.
:::
</TabItem>
<TabItem value="cli">
All User config options are available in the python CLI. Example commands are below:
Please see instructions for [Enabling HAM License](/docs/software/python/python-uses#ham-radio-support)
```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'
```
</TabItem>
<TabItem value="flasher">
:::info
No User config options are available in the Flasher.
:::
</TabItem>
<TabItem value="web">
:::info
All User config options are available in the Web UI.
:::
</TabItem>
</Tabs>