mudhorn/meshtastic
1
0
Fork 0
mirror of https://github.com/meshtastic/meshtastic.git synced 2024-12-24 05:04:11 -08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Removed descriptions from table

Browse source
This commit is contained in:
Foster Irwin 2021-05-03 14:15:01 -06:00
parent 8f0936e122
commit bc5c82ff27
3 changed files with 101 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
website/docs/settings/misc.md
View file

@ -12,10 +12,30 @@ sidebar_label: Miscellaneous
| Setting | Acceptable Values | Default | Description |
| :-----: | :---------------: | :-----: | :---------: |
| frequency_offset | real numbers | `0` | This parameter is for advanced users with advanced test equipment, we do not recommend most users use it. A frequency offset that is added to to the calculated band center frequency. Used to correct for crystal calibration errors. |
| debug_log_enabled | `true`, `false` | `false` | By default we turn off logging as soon as an API client connects (to keep shared serial link quiet). Set this to true to leave the debug log outputting even when API is active. |
| ignore_incoming | `string` – list of node nums to ignore | `0` | If true, radio should not try to be smart about what packets to queue to the phone bool keep_all_packets = 101; If true, we will try to capture all the packets sent on the mesh, not just the ones destined to our node. bool promiscuous_mode = 102; For testing it is useful sometimes to force a node to never listen to particular other nodes (simulating radio out of range). All nodenums listed in ignore_incoming will have packets they send droped on receive (by router.cpp) |
| factory_reset | `true`, `false` | `false` | This setting is never saved to disk, but if set, all device settings will be returned to factory defaults. (Region, serial number etc... will be preserved) |
| serial_disabled | `true`, `false` | `false` | If set, this will disable the SerialConsole by not initilizing the StreamAPI |
| debug_log_enabled | `true`, `false` | `false` |
| factory_reset | `true`, `false` | `false` |
| frequency_offset | real numbers | `0` |
| ignore_incoming | `string` – list of node nums to ignore | `0` |
| serial_disabled | `true`, `false` | `false` |
### debug_log_enabled
By default we turn off logging as soon as an API client connects (to keep shared serial link quiet). Set this to true to leave the debug log outputting even when API is active.
### factory_reset
This setting is never saved to disk, but if set, all device settings will be returned to factory defaults. (Region, serial number etc... will be preserved)
### frequency_offset
This parameter is for advanced users with advanced test equipment, we do not recommend most users use it. A frequency offset that is added to to the calculated band center frequency. Used to correct for crystal calibration errors.
### ignore_incoming
If true, radio should not try to be smart about what packets to queue to the phone bool keep_all_packets = 101; If true, we will try to capture all the packets sent on the mesh, not just the ones destined to our node. bool promiscuous_mode = 102; For testing it is useful sometimes to force a node to never listen to particular other nodes (simulating radio out of range). All nodenums listed in ignore_incoming will have packets they send dropped on receive (by router.cpp)
### serial_disabled
If set, this will disable the SerialConsole by not initilizing the StreamAPI.
## Details

17
website/docs/settings/mqtt.md
View file

@ -10,9 +10,18 @@ sidebar_label: MQTT
## Settings
| Setting | Acceptable Values | Default | Description |
| :-----: | :---------------: | :-----: | :---------: |
| mqtt_disabled | `true`, `false` | `true` | If a meshtastic node is able to reach the internet it will normally attempt to gateway any channels that are marked as is_uplink_enabled or is_downlink_enabled. But if this flag is set, all MQTT features will be disabled and no servers will be contacted. |
| mqtt_server | `string` | `""` | The server to use for our MQTT global message gateway feature. If not set, the default server will be used |
| Setting | Acceptable Values | Default |
| :-----: | :---------------: | :-----: |
| mqtt_disabled | `true`, `false` | `true` |
| mqtt_server | `string` | `""` |
### mqtt_disabled
If a meshtastic node is able to reach the internet it will normally attempt to gateway any channels that are marked as is_uplink_enabled or is_downlink_enabled. But if this flag is set, all MQTT features will be disabled and no servers will be contacted.
The server to use for our MQTT global message gateway feature. If not set, the default server will be used
### mqtt_server
The server to use for our MQTT global message gateway feature. If not set, the default server will be used
## Details

66
website/docs/settings/power.md
View file

@ -12,17 +12,77 @@ sidebar_label: Power
| Setting | Acceptable Values | Default | Description |
| :-----: | :---------------: | :-----: | :---------: |
| charge_current | `MAUnset`, `MA100`, `MA190`, `MA280`, `MA360`, `MA450`, `MA550`, `MA630`, `MA700`, `MA780`, `MA880`, `MA960`, `MA1000`, `MA1080`, `MA1160`, `MA1240`, `MA1320` | | Sets the current of the battery charger |
| charge_current | `MAUnset`, `MA100`, `MA190`, `MA280`, `MA360`, `MA450`, `MA550`, `MA630`, `MA700`, `MA780`, `MA880`, `MA960`, `MA1000`, `MA1080`, `MA1160`, `MA1240`, `MA1320`: | `MAUnset` | Sets the current of the battery charger |
| is_low_power | `true`, `false` | `false` | If set, we are powered from a low-current source (i.e. solar), so even if it looks like we have power flowing in we should try to minimize power consumption as much as possible. YOU DO NOT NEED TO SET THIS IF YOU'VE set is_router (it is implied in that case). |
| is_router | `true`, `false` | `false` | Are we operating as a router. Changes behavior in the following ways: The device will only sleep for critically low battery level (i.e. always tries to stay alive for the mesh) In the future routing decisions will preferentially route packets through nodes with this attribute (because assumed good line of sight) |
| ls_secs | `integer` (seconds) | `0` | Power management state machine option. See the [power page](../software/other/power) for details. 0 for default of 3600 |
| ls_secs | `integer` (seconds) | `0` (see note) | Power management state machine option. See the [power page](../software/other/power) for details. 0 for default of 3600 |
| mesh_sds_timeout_secs | `integer` (seconds) | `0` | Power management state machine option. See the [power page](../software/other/power) for details. 0 for default of two hours, MAXUINT for disabled |
| min_wake_secs | `integer` (seconds) | `0` | Power management state machine option. See the [power page](../software/other/power)for details. 0 for default of 10 seconds |
| phone_sds_timeout_sec | `integer` (seconds) | `0` | Power management state machine option. See the [power page](../software/other/power) for details. 0 for default of two hours, MAXUINT for disabled |
| phone_timeout_secs | `integer` (seconds) | `0` | Power management state machine option. See the [power page](../software/other/power) for details. 0 for default of 15 minutes |
| screen_on_secs | `integer` (seconds) | `0` | Power management state machine option. See the [power page](../software/other/power) for details. 0 for default of one minute |
| sds_secs | `integer` (seconds) | `0` | Power management state machine option. See the [power page](../software/other/power) for details. 0 for default of one year |
| send_owner_interval | `integer` (seconds) | `0` | Send our owner info at least this often (also we always send once at boot - to rejoin the mesh) |
| send_owner_interval | `integer` (seconds) | `4` | Send our owner info at least this often (also we always send once at boot - to rejoin the mesh) |
| wait_bluetooth_secs | `integer` (seconds) | `0` | Power management state machine option. See the [power page](../software/other/power) for details. 0 for default of 1 minute |
:::note
When you the following settings to `0` they assume the following defaults:
- `ls_secs`: 1 hour
- `mesh_sds_timeout_secs`: 2 hours
- `min_wake_secs`: 10 seconds
- `phone_sds_timeout_sec`: 2 hours
- `phone_timeout_secs`: 15 minutes
- `screen_on_secs`: 1 minute
- `sds_secs`: 1 year
- `wait_bluetooth_secs`: 1 minute
:::
### charge_current
Sets the current of the battery charger
### is_low_power
If set, we are powered from a low-current source (i.e. solar), so even if it looks like we have power flowing in we should try to minimize power consumption as much as possible. YOU DO NOT NEED TO SET THIS IF YOU'VE set is_router (it is implied in that case).
### is_router
Are we operating as a router. Changes behavior in the following ways: The device will only sleep for critically low battery level (i.e. always tries to stay alive for the mesh) In the future routing decisions will preferentially route packets through nodes with this attribute (because assumed good line of sight)
### ls_secs
Power management state machine option. See the [power page](../software/other/power) for details. 0 for default of 3600
### mesh_sds_timeout_secs
Power management state machine option. See the [power page](../software/other/power) for details. 0 for default of two hours, MAXUINT for disabled
### min_wake_secs
### phone_sds_timeout_sec
### phone_timeout_secs
### screen_on_secs
### sds_secs
### send_owner_interval
### wait_bluetooth_secs
## Details