mirror of
https://github.com/meshtastic/meshtastic.git
synced 2024-09-21 00:27:35 -07:00
Merge pull request #417 from sigmahour/master
updates to wifi, user, and ham docs
This commit is contained in:
Andre K
GitHub
commit
9eb705e1be
29
docs/faq/ham.mdx
Normal file
29
docs/faq/ham.mdx
Normal file
|
|
@ -0,0 +1,29 @@
|
|||
---
|
||||
id: ham
|
||||
title: FAQs - HAM
|
||||
sidebar_label: Amateur Radio (HAM)
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
||||
Meshtastic can be used by both unlicensed people and licensed HAM operators.
|
||||
|
||||
### What is the benefit of using a HAM license with Meshtastic?
|
||||
|
||||
If you use your HAM radio license with Meshtastic, consider both the privileges and restrictions:
|
||||
|
||||
#### Privileges
|
||||
- Increased Transmit Power
|
||||
- Up to 1500W transmit power! [FCC Part 97.313](https://www.ecfr.gov/current/title-47/chapter-I/subchapter-D/part-97/subpart-D/section-97.313)
|
||||
- Higher Gain Antennas
|
||||
|
||||
#### Restrictions
|
||||
- Plain-Text Only
|
||||
- On amateur radio bands, encryption is illegal. [FCC Part 97.113.C](https://www.ecfr.gov/current/title-47/chapter-I/subchapter-D/part-97/subpart-B/section-97.113)
|
||||
- Lack of Privacy
|
||||
- As a HAM operator, it is a requirement that you identify yourself by your call sign periodically when transmitting. Your call sign will be publicly transmitted at least once every 10 minutes at minimum. [FCC Part 97.119.A](https://www.ecfr.gov/current/title-47/chapter-I/subchapter-D/part-97/subpart-B/section-97.119)
|
||||
|
||||
|
||||
### How do I set my HAM call sign?
|
||||
|
||||
Please see instructions for [Enabling HAM License from the Python CLI](/docs/software/python/python-uses#ham-radio-support)
|
||||
|
|
@ -16,5 +16,5 @@ Default settings values are prefered whenever possible as they consume no bandwi
|
|||
| [LoRa](lora) | The LoRa config options are: Region, Modem Preset, Max Hops, Transmit Power, Bandwidth, Spread Factor, Coding Rate, Frequency Offset, Transmit Disabled and Ignore Incoming Array. |
|
||||
| [Position](position) | Positon config options are: GPS Enabled, GPS Update Interval, GPS Attempt Time, Fixed Postion, Smart Broadcast, Broadcast Interval and Position Packet Flags. |
|
||||
| [Power](power) | Power config options are: Charge Current, Power Saving, Shutdown after losing power, ADC Multiplier Override Wait Bluetooth Interval, Mesh Super Deep Sleep Timeout, Super Deep Sleep Interval, Light Sleep Interval and Minimum Wake Interval. |
|
||||
| [User](user) | The user config options are: Short Name, Long Name, Licensed Operator, Transmit Power at Antenna Connector, Antenna Gain and Antenna Azimuth. |
|
||||
| [User](user) | The user config options are: Long Name, Short Name, and Is Licensed |
|
||||
| [Network](network) | Network config options are: Wifi Enabled, WiFi SSID, Wifi PSK, WiFi Mode and NTP Server. |
|
||||
|
|
|
|||
|
|
@ -7,27 +7,38 @@ sidebar_label: User
|
|||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
The user config options are: Short Name, Long Name, Licensed Operator, Transmit Power at Antenna Connector, Antenna Gain and Antenna Azimuth. User config uses an admin message sending a `User` protobuf.
|
||||
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
|
||||
|
||||
### Short Name
|
||||
|
||||
### Long Name
|
||||
|
||||
### Licensed Operator
|
||||
A personalised name for your device.
|
||||
|
||||
### Transmit Power at Antenna Connector
|
||||
Auto-generated by default.
|
||||
|
||||
### Antenna Gain
|
||||
If you are a licensed HAM operator and have enabled `IsLicensed`, this should be set to your HAM operator call sign.
|
||||
|
||||
### Antenna Azimuth
|
||||
### Short Name
|
||||
|
||||
## Device Config Client Availability
|
||||
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="android"
|
||||
defaultValue="cli"
|
||||
values={[
|
||||
{label: 'Android', value: 'android'},
|
||||
{label: 'Apple', value: 'apple'},
|
||||
|
|
@ -35,37 +46,50 @@ values={[
|
|||
{label: 'Flasher', value: 'flasher'},
|
||||
{label: 'Web', value: 'web'},
|
||||
]}>
|
||||
|
||||
<TabItem value="android">
|
||||
|
||||
:::info
|
||||
Long Name can be edited on Android.
|
||||
`LongName` can be edited on Android.
|
||||
:::
|
||||
|
||||
</TabItem>
|
||||
|
||||
<TabItem value="apple">
|
||||
|
||||
:::info
|
||||
Short Name and Long Name user config options are available on iOS, iPadOS and macOS at Settings > Radio Configuration > User.
|
||||
`ShortName` and `LongName` User config options are available on iOS, iPadOS and macOS at `Settings > Radio Configuration > User`.
|
||||
:::
|
||||
|
||||
</TabItem>
|
||||
|
||||
<TabItem value="cli">
|
||||
|
||||
All display config options are available in the python CLI. Example commands are below:
|
||||
All User config options are available in the python CLI. Example commands are below:
|
||||
|
||||
| Setting | Acceptable Values | Default |
|
||||
| :-----------: | :---------------: | :-----: |
|
||||
| LongName | string | auto-generated |
|
||||
| ShortName | string | auto-generated |
|
||||
| IsLicensed | bool | `false` |
|
||||
|
||||
Please see instructions for [Enabling HAM License](/docs/software/python/python-uses#ham-radio-support)
|
||||
|
||||
</TabItem>
|
||||
|
||||
<TabItem value="flasher">
|
||||
|
||||
:::info
|
||||
No user config options are available in the Flasher.
|
||||
No User config options are available in the Flasher.
|
||||
:::
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="web">
|
||||
</TabItem>
|
||||
|
||||
<TabItem value="web">
|
||||
|
||||
:::info
|
||||
All user config options are available in the Web UI.
|
||||
All User config options are available in the Web UI.
|
||||
:::
|
||||
|
||||
</TabItem>
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
|
@ -22,53 +22,45 @@ You can [force the device to boot into SoftAP mode](#software-access-point) by r
|
|||
|
||||
### NTP Server
|
||||
|
||||
Type: **string** (Max Length: 33)
|
||||
The NTP server used if IP networking is available.
|
||||
|
||||
Default: `0.pool.ntp.org`
|
||||
|
||||
The NTP server used if WiFi is conneced.
|
||||
Set to `0.pool.ntp.org` by default. (Max Length: 33)
|
||||
|
||||
### Wifi Enabled
|
||||
|
||||
Type: **bool**
|
||||
Enables or Disables WiFi.
|
||||
|
||||
Default: `false` (Disabled)
|
||||
|
||||
Enables and Disables WiFi.
|
||||
Set to `false` (Disabled) by default.
|
||||
|
||||
### WiFi SSID
|
||||
|
||||
Type: **string** (Case Sensitive, Max Length: 33)
|
||||
|
||||
Default: `""` (Empty)
|
||||
|
||||
In [SoftAP](#software-access-point) mode, this is the SSID broadcast to access your device's WiFi.
|
||||
|
||||
In [Client](#wifi-client) mode, this is your WiFi Networks SSID.
|
||||
|
||||
Empty `""` by default. (Case Sensitive, Max Length: 33)
|
||||
|
||||
### WiFi PSK
|
||||
|
||||
Type: **string** (Case Sensitive, Max Length: 64)
|
||||
|
||||
Default: `""` (Empty)
|
||||
|
||||
In [SoftAP](#software-access-point) mode, this is the password to access your device's WiFi.
|
||||
|
||||
In [Client](#wifi-client) mode, this is your WiFi Networks password.
|
||||
|
||||
Empty `""` by default. (Case Sensitive, Max Length: 64)
|
||||
|
||||
### WiFi Mode
|
||||
|
||||
Type: **enum**
|
||||
Used to set either [SoftAP](#software-access-point) or [Client](#wifi-client) WiFi modes.
|
||||
|
||||
Default: `Client`
|
||||
Set to `CLIENT` by default.
|
||||
|
||||
#### Acceptable values
|
||||
|
||||
| Value | Description |
|
||||
| :-------: | :--------------------------: |
|
||||
| `CLIENT` | Client |
|
||||
| `ACCESS_POINT` | [Software Access Point](#software-access-point) |
|
||||
| `ACCESS_POINT_HIDDEN` | Software Access Point (Hidden) |
|
||||
| `ACCESS_POINT` | (SoftAP) [Software Access Point](#software-access-point) |
|
||||
| `ACCESS_POINT_HIDDEN` | (SoftAP) Software Access Point (Hidden) |
|
||||
|
||||
:::tip
|
||||
The first time your device restarts after enabling the WiFi access point, it will take an additional 20-30 seconds to boot. This is to generate self-signed SSL keys. The keys will be saved for future reuse.
|
||||
|
|
@ -205,7 +197,7 @@ You should then be able to connect to the node using either the displayed IP add
|
|||
|
||||
### WiFi Client
|
||||
|
||||
With `network.wifi_ssid` & `network.wifi_psk` populated, the device will know to connect to your network. Make sure you are in range of your WiFi. If you have a single device on your local network it's easy to connect to your device `http://meshtastic.local`. If you have multiple devices you will need to connect using their respective IP addresses.
|
||||
With `network.wifi_ssid` & `network.wifi_psk` populated, the device will know to connect to your network. Make sure you are in range of your WiFi. If you have a single Meshtastic device on your local network it's easy to connect to your device with DNS `http://meshtastic.local`. If you have multiple Meshtastic devices you will need to connect using their respective IP addresses.
|
||||
|
||||
If you have a screen attached to your device, the final page will display something similar to the following:
|
||||
|
||||
|
|
|
|||
|
|
@ -95,6 +95,15 @@ Setting Ham ID to KI1345 and turning off encryption
|
|||
Writing modified channels to device
|
||||
```
|
||||
|
||||
Toggling `set-ham` changes your device settings in the following ways.
|
||||
|
||||
| Setting | `set-ham` Default | Normal Default |
|
||||
| :----------------------: | :---------------: | :---------------------------------------: |
|
||||
| `IsLicensed` | `true` | See [User Config - IsLicensed](/docs/settings/config/user#is-licensed-ham) |
|
||||
| `LongName` | _Your CallSign_ | See [User Config - LongName](/docs/settings/config/user#long-name) |
|
||||
| `ShortName` | _Abrv CallSign_ | See [User Config - ShortName](/docs/settings/config/user#short-name) |
|
||||
| `PSK` | `""` | See [Channel Settings - PSK](#changing-the-preshared-key) |
|
||||
|
||||
## Changing the preshared key:
|
||||
|
||||
You can set the channel preshared key to a particular AES128 or AES256 sequence.
|
||||
|
|
|
|||
Loading…
Reference in a new issue