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

update protos and fix links

Browse source
This commit is contained in:
sigmahour 2022-11-09 02:16:52 -05:00
parent 313dcc6341
commit 5ab91481b4
4 changed files with 48 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

57
docs/development/reference/protobuf-api.mdx
View file

@ -96,6 +96,7 @@ TODO: REPLACE
| `RANGETEST_CONFIG` | `4` | TODO: REPLACE |
| `TELEMETRY_CONFIG` | `5` | TODO: REPLACE |
| `CANNEDMSG_CONFIG` | `6` | TODO: REPLACE |
| `AUDIO_CONFIG` | `7` | TODO: REPLACE |
@ -553,18 +554,6 @@ Note: these mappings must match ModemPreset Choice in the device code.
### Config.NetworkConfig.WiFiMode
| Name | Number | Description |
| ---- | ------ | ----------- |
| `CLIENT` | `0` | This mode is used to connect to an external WiFi network |
| `ACCESS_POINT` | `1` | In this mode the node will operate as an AP (and DHCP server) |
| `ACCESS_POINT_HIDDEN` | `2` | If set, the node AP will broadcast as a hidden SSID |
### Config.PositionConfig.PositionFlags
:::note `enum` description
@ -744,6 +733,7 @@ TODO: REPLACE
| range_test | [`ModuleConfig.RangeTestConfig`](#moduleconfigrangetestconfig) | The part of the config that is specific to the RangeTest module |
| telemetry | [`ModuleConfig.TelemetryConfig`](#moduleconfigtelemetryconfig) | The part of the config that is specific to the Telemetry module |
| canned_message | [`ModuleConfig.CannedMessageConfig`](#moduleconfigcannedmessageconfig) | The part of the config that is specific to the Canned Message module |
| audio | [`ModuleConfig.AudioConfig`](#moduleconfigaudioconfig) | The part of the config that is specific to the Audio module |
| version | uint32 | A version integer used to invalidate old save files when we make incompatible changes This integer is set at build time and is private to NodeDB.cpp in the device code. |
@ -1335,6 +1325,26 @@ Module Config
| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) payload_variant.range_test | [`ModuleConfig.RangeTestConfig`](#moduleconfigrangetestconfig) | TODO: REPLACE |
| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) payload_variant.telemetry | [`ModuleConfig.TelemetryConfig`](#moduleconfigtelemetryconfig) | TODO: REPLACE |
| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) payload_variant.canned_message | [`ModuleConfig.CannedMessageConfig`](#moduleconfigcannedmessageconfig) | TODO: REPLACE |
| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) payload_variant.audio | [`ModuleConfig.AudioConfig`](#moduleconfigaudioconfig) | TODO: REPLACE |
### ModuleConfig.AudioConfig
:::note `message` description
Audio Config for codec2 voice
:::
| Field | Type | Description |
| ----- | ---- | ----------- |
| codec2_enabled | bool | Whether Audio is enabled |
| mic_chan | uint32 | ADC where Microphone is connected |
| amp_pin | uint32 | DAC where Speaker is connected |
| ptt_pin | uint32 | PTT Pin |
| bitrate | [`ModuleConfig.AudioConfig.Audio_Baud`](#moduleconfigaudioconfigaudio_baud) | The audio sample rate to use for codec2 |
@ -1484,6 +1494,28 @@ Configuration for both device and environment metrics
### ModuleConfig.AudioConfig.Audio_Baud
:::note `enum` description
Baudrate for codec2 voice
:::
| Name | Number | Description |
| ---- | ------ | ----------- |
| `CODEC2_DEFAULT` | `0` | none |
| `CODEC2_3200` | `1` | none |
| `CODEC2_2400` | `2` | none |
| `CODEC2_1600` | `3` | none |
| `CODEC2_1400` | `4` | none |
| `CODEC2_1300` | `5` | none |
| `CODEC2_1200` | `6` | none |
| `CODEC2_700` | `7` | none |
| `CODEC2_700B` | `8` | none |
### ModuleConfig.CannedMessageConfig.InputEventChar
:::note `enum` description
@ -1611,6 +1643,7 @@ This change is backwards compatible by treating the legacy OPAQUE/CLEAR_TEXT val
| `ADMIN_APP` | `6` | Admin control packets. Payload is a [AdminMessage](/docs/developers/protobufs/api#adminmessage) message |
| `TEXT_MESSAGE_COMPRESSED_APP` | `7` | Compressed TEXT_MESSAGE payloads. |
| `WAYPOINT_APP` | `8` | Waypoint payloads. Payload is a [Waypoint](/docs/developers/protobufs/api#waypoint) message |
| `AUDIO_APP` | `9` | Audio Payloads. Encapsulated codec2 packets. On 2.4 GHZ Bandwidths only for now |
| `REPLY_APP` | `32` | Provides a 'ping' service that replies to any packet it receives. Also serves as a small example module. |
| `IP_TUNNEL_APP` | `33` | Used for the python IP tunnel feature |
| `SERIAL_APP` | `64` | Provides a hardware serial interface to send and receive from the Meshtastic network. Connect to the RX/TX pins of a device with 38400 8N1. Packets received from the Meshtastic network is forwarded to the RX pin while sending a packet to TX will go out to the Mesh network. Maximum packet size of 240 bytes. Module is disabled by default can be turned on by setting SERIAL_MODULE_ENABLED = 1 in SerialPlugh.cpp. |

1
docs/guides/gpio-peripherals.mdx
View file

@ -2,6 +2,7 @@
id: gpio-peripherals
title: Configuring GPIO Peripherals
sidebar_label: Setup GPIO Peripherals
slug: /hardware/peripheral/
sidebar_position: 6
---

2
docs/hardware/devices/rak/index.mdx
View file

@ -14,7 +14,7 @@ The RAK WisBlock is a modular hardware system that can be used to build Meshtast
RAK Wireless currently sells a [Meshtastic Starter kit](https://store.rakwireless.com/products/wisblock-meshtastic-starter-kit) that has the minimum you need to get started.
If you wish to purchase parts separately, you will need a [WisBlock Base Board](/docs/hardware/devices/rak/base) and a [WisBlock Core Module](/docs/hardware/devices/rak/core). Please ensure you choose the correct operating frequency for your country when purchasing.
If you wish to purchase parts separately, you will need a [WisBlock Base Board](/docs/hardware/devices/rak/base-board) and a [WisBlock Core Module](/docs/hardware/devices/rak/core-module). Please ensure you choose the correct operating frequency for your country when purchasing.
You can optionally purchase peripherals such as a GPS module, Screen, Sensor, or other various modules.

2
protobufs

@ -1 +1 @@
Subproject commit 6b46e42a656dd3aab74c373e79b70e699eeac834
Subproject commit c82c15aac71b9134d96c03dbe319916739cc8314