mirror of
https://github.com/meshtastic/meshtastic.git
synced 2025-02-02 08:42:11 -08:00
4c425c229f
* add icons to tabs (where it makes sense) * fix dependency advisories * fix numbered list * fix admonition
154 lines
3.2 KiB
Plaintext
154 lines
3.2 KiB
Plaintext
---
|
|
id: user
|
|
title: User Configuration
|
|
sidebar_label: User
|
|
description: Details on Long Name, Short Name, and Licensed operation.
|
|
---
|
|
|
|
import Tabs from "@theme/Tabs";
|
|
import TabItem from "@theme/TabItem";
|
|
import { Icon } from "@iconify/react";
|
|
|
|
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 personalized 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/#amateur-radio-ham) 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)
|
|
|
|
## User Config Client Availability
|
|
|
|
<Tabs
|
|
groupId="settings"
|
|
defaultValue="apple"
|
|
values={[
|
|
{
|
|
label: (
|
|
<>
|
|
<Icon icon="mdi:android" height="1.5rem" style={{ marginRight: "0.25rem" }} /> Android
|
|
</>
|
|
),
|
|
value: "android",
|
|
},
|
|
{
|
|
label: (
|
|
<>
|
|
<Icon icon="mdi:apple" height="1.5rem" style={{ marginRight: "0.25rem" }} /> Apple
|
|
</>
|
|
),
|
|
value: "apple",
|
|
},
|
|
{
|
|
label: (
|
|
<>
|
|
<Icon icon="mdi:terminal" height="1.5rem" style={{ marginRight: "0.25rem" }} /> CLI
|
|
</>
|
|
),
|
|
value: "cli",
|
|
},
|
|
{
|
|
label: (
|
|
<>
|
|
<Icon icon="mdi:internet" height="1.5rem" style={{ marginRight: "0.25rem" }} /> Web
|
|
</>
|
|
),
|
|
value: "web",
|
|
},
|
|
]}>
|
|
|
|
<TabItem value="android">
|
|
|
|
#### Android
|
|
|
|
:::info
|
|
|
|
All User config options are available for Android.
|
|
|
|
1. Open the Meshtastic App
|
|
2. Navigate to: **Vertical Ellipsis (3 dots top right) > Radio Configuration > User**
|
|
|
|
:::
|
|
|
|
</TabItem>
|
|
|
|
<TabItem value="apple">
|
|
|
|
#### Apple
|
|
|
|
:::info
|
|
|
|
All User config options are available on iOS, iPadOS and macOS at Settings > Device Configuration > User.
|
|
|
|
:::
|
|
|
|
</TabItem>
|
|
|
|
<TabItem value="cli">
|
|
|
|
#### CLI
|
|
|
|
:::info
|
|
|
|
All User config options are available in the python CLI. Example commands are below:
|
|
|
|
:::
|
|
|
|
Please see instructions for [Enabling HAM License](/docs/software/python/cli/usage#ham-radio-support)
|
|
|
|
:::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'
|
|
```
|
|
|
|
</TabItem>
|
|
|
|
<TabItem value="web">
|
|
|
|
#### Web
|
|
|
|
:::info
|
|
All User config options are available in the Web UI.
|
|
:::
|
|
|
|
</TabItem>
|
|
</Tabs>
|