mirror of
https://github.com/meshcore-dev/MeshCore.git
synced 2026-04-20 22:13:47 +00:00
Merge branch 'dev' of https://github.com/meshcore-dev/MeshCore into dev
This commit is contained in:
commit
fa662d73e9
39 changed files with 1082 additions and 225 deletions
8
.github/workflows/pr-build-check.yml
vendored
8
.github/workflows/pr-build-check.yml
vendored
|
|
@ -9,6 +9,14 @@ on:
|
|||
- 'variants/**'
|
||||
- 'platformio.ini'
|
||||
- '.github/workflows/pr-build-check.yml'
|
||||
push:
|
||||
branches: [main, dev]
|
||||
paths:
|
||||
- 'src/**'
|
||||
- 'examples/**'
|
||||
- 'variants/**'
|
||||
- 'platformio.ini'
|
||||
- '.github/workflows/pr-build-check.yml'
|
||||
|
||||
jobs:
|
||||
build:
|
||||
|
|
|
|||
|
|
@ -46,7 +46,8 @@
|
|||
],
|
||||
"debug": {
|
||||
"jlink_device": "nRF52840_xxAA",
|
||||
"svd_path": "nrf52840.svd"
|
||||
"svd_path": "nrf52840.svd",
|
||||
"openocd_target": "nrf52.cfg"
|
||||
},
|
||||
"frameworks": [
|
||||
"arduino"
|
||||
|
|
|
|||
|
|
@ -46,7 +46,8 @@
|
|||
],
|
||||
"debug": {
|
||||
"jlink_device": "nRF52840_xxAA",
|
||||
"svd_path": "nrf52840.svd"
|
||||
"svd_path": "nrf52840.svd",
|
||||
"openocd_target": "nrf52.cfg"
|
||||
},
|
||||
"frameworks": [
|
||||
"arduino"
|
||||
|
|
|
|||
|
|
@ -63,6 +63,12 @@ This document provides an overview of CLI commands that can be sent to MeshCore
|
|||
|
||||
---
|
||||
|
||||
### Send a zero-hop advert
|
||||
**Usage:**
|
||||
- `advert.zerohop`
|
||||
|
||||
---
|
||||
|
||||
### Start an Over-The-Air (OTA) firmware update
|
||||
**Usage:**
|
||||
- `start ota`
|
||||
|
|
@ -355,13 +361,25 @@ This document provides an overview of CLI commands that can be sent to MeshCore
|
|||
|
||||
---
|
||||
|
||||
#### View this node's public key
|
||||
**Usage:** `get public.key`
|
||||
|
||||
---
|
||||
|
||||
#### View this node's configured role
|
||||
**Usage:** `get role`
|
||||
|
||||
---
|
||||
|
||||
#### View or change this node's power saving flag (Repeater Only)
|
||||
**Usage:**
|
||||
- `powersaving <state>`
|
||||
- `powersaving`
|
||||
- `powersaving on`
|
||||
- `powersaving off`
|
||||
|
||||
**Parameters:**
|
||||
- `state`: `on`|`off`
|
||||
- `on`: enable power saving
|
||||
- `off`: disable power saving
|
||||
|
||||
**Default:** `on`
|
||||
|
||||
|
|
@ -383,6 +401,46 @@ This document provides an overview of CLI commands that can be sent to MeshCore
|
|||
|
||||
---
|
||||
|
||||
#### View or change this node's advert path hash size
|
||||
**Usage:**
|
||||
- `get path.hash.mode`
|
||||
- `set path.hash.mode <value>`
|
||||
|
||||
**Parameters:**
|
||||
- `value`: Path hash size (0-2)
|
||||
- `0`: 1 Byte hash size (256 unique ids)[64 max flood]
|
||||
- `1`: 2 Byte hash size (65,536 unique ids)[32 max flood]
|
||||
- `2`: 3 Byte hash size (16,777,216 unique ids)[21 max flood]
|
||||
- `3`: DO NOT USE (Reserved)
|
||||
|
||||
**Default:** `0`
|
||||
|
||||
**Note:** the 'path.hash.mode' sets the low-level ID/hash encoding size used when the repeater adverts. This setting has no impact on what packet ID/hash size this repeater forwards, all sizes should be forwarded on firmware >= 1.14. This feature was added in firmware 1.14
|
||||
|
||||
**Temporary Note:** adverts with ID/hash sizes of 2 or 3 bytes may have limited flood propogation in your network while this feature is new as v1.13.0 firmware and older will drop packets with multibyte path ID/hashes as only 1-byte hashes are suppored. Consider your install base of firmware >=1.14 has reached a criticality for effective network flooding before implementing higher ID/hash sizes.
|
||||
|
||||
---
|
||||
|
||||
#### View or change this node's loop detection
|
||||
**Usage:**
|
||||
- `get loop.detect`
|
||||
- `set loop.detect <state>`
|
||||
|
||||
**Parameters:**
|
||||
- `state`:
|
||||
- `off`: no loop detection is performed
|
||||
- `minimal`: packets are dropped if repeater's ID/hash appears 4 or more times (1-byte), 2 or more (2-byte), 1 or more (3-byte)
|
||||
- `moderate`: packets are dropped if repeater's ID/hash appears 2 or more times (1-byte), 1 or more (2-byte), 1 or more (3-byte)
|
||||
- `strict`: packets are dropped if repeater's ID/hash appears 1 or more times (1-byte), 1 or more (2-byte), 1 or more (3-byte)
|
||||
|
||||
**Default:** `off`
|
||||
|
||||
**Note:** When it is enabled, repeaters will now reject flood packets which look like they are in a loop. This has been happening recently in some meshes when there is just a single 'bad' repeater firmware out there (prob some forked or custom firmware). If the payload is messed with, then forwarded, the same packet ends up causing a packet storm, repeated up to the max 64 hops. This feature was added in firmware 1.14
|
||||
|
||||
**Example:** If preference is `loop.detect minimal`, and a 1-byte path size packet is received, the repeater will see if its own ID/hash is already in the path. If it's already encoded 4 times, it will reject the packet. If the packet uses 2-byte path size, and repeater's own ID/hash is already encoded 2 times, it rejects. If the packet uses 3-byte path size, and the repeater's own ID/hash is already encoded 1 time, it rejects.
|
||||
|
||||
---
|
||||
|
||||
#### View or change the retransmit delay factor for flood traffic
|
||||
**Usage:**
|
||||
- `get txdelay`
|
||||
|
|
@ -804,6 +862,11 @@ region save
|
|||
|
||||
### Bridge (When bridge support is compiled in)
|
||||
|
||||
#### View the compiled bridge type
|
||||
**Usage:** `get bridge.type`
|
||||
|
||||
---
|
||||
|
||||
#### View or change the bridge enabled flag
|
||||
**Usage:**
|
||||
- `get bridge.enabled`
|
||||
|
|
@ -816,12 +879,6 @@ region save
|
|||
|
||||
---
|
||||
|
||||
#### View the bridge source
|
||||
**Usage:**
|
||||
- `get bridge.source`
|
||||
|
||||
---
|
||||
|
||||
#### Add a delay to packets routed through this bridge
|
||||
**Usage:**
|
||||
- `get bridge.delay`
|
||||
|
|
@ -841,10 +898,10 @@ region save
|
|||
|
||||
**Parameters:**
|
||||
- `source`:
|
||||
- `rx`: bridges received packets
|
||||
- `tx`: bridges transmitted packets
|
||||
- `logRx`: bridges received packets
|
||||
- `logTx`: bridges transmitted packets
|
||||
|
||||
**Default:** `tx`
|
||||
**Default:** `logTx`
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -876,8 +933,39 @@ region save
|
|||
- `set bridge.secret <secret>`
|
||||
|
||||
**Parameters:**
|
||||
- `secret`: 16-character encryption secret
|
||||
- `secret`: ESP-NOW bridge secret, up to 15 characters
|
||||
|
||||
**Default:** Varies by board
|
||||
|
||||
---
|
||||
|
||||
#### View the bootloader version (nRF52 only)
|
||||
**Usage:** `get bootloader.ver`
|
||||
|
||||
---
|
||||
|
||||
#### View power management support
|
||||
**Usage:** `get pwrmgt.support`
|
||||
|
||||
---
|
||||
|
||||
#### View the current power source
|
||||
**Usage:** `get pwrmgt.source`
|
||||
|
||||
**Note:** Returns an error on boards without power management support.
|
||||
|
||||
---
|
||||
|
||||
#### View the boot reset and shutdown reasons
|
||||
**Usage:** `get pwrmgt.bootreason`
|
||||
|
||||
**Note:** Returns an error on boards without power management support.
|
||||
|
||||
---
|
||||
|
||||
#### View the boot voltage
|
||||
**Usage:** `get pwrmgt.bootmv`
|
||||
|
||||
**Note:** Returns an error on boards without power management support.
|
||||
|
||||
---
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# Companion Protocol
|
||||
|
||||
- **Last Updated**: 2026-01-03
|
||||
- **Last Updated**: 2026-03-08
|
||||
- **Protocol Version**: Companion Firmware v1.12.0+
|
||||
|
||||
> NOTE: This document is still in development. Some information may be inaccurate.
|
||||
|
|
@ -100,7 +100,7 @@ When writing commands to the RX characteristic, specify the write type:
|
|||
|
||||
### MTU (Maximum Transmission Unit)
|
||||
|
||||
The default BLE MTU is 23 bytes (20 bytes payload). For larger commands like `SET_CHANNEL` (66 bytes), you may need to:
|
||||
The default BLE MTU is 23 bytes (20 bytes payload). For larger commands like `SET_CHANNEL` (50 bytes), you may need to:
|
||||
|
||||
1. **Request Larger MTU**: Request MTU of 512 bytes if supported
|
||||
- Android: `gatt.requestMtu(512)`
|
||||
|
|
@ -167,16 +167,16 @@ The first byte indicates the packet type (see [Response Parsing](#response-parsi
|
|||
**Command Format**:
|
||||
```
|
||||
Byte 0: 0x01
|
||||
Byte 1: 0x03
|
||||
Bytes 2-10: "mccli" (ASCII, null-padded to 9 bytes)
|
||||
Bytes 1-7: Reserved (currently ignored by firmware)
|
||||
Bytes 8+: Application name (UTF-8, optional)
|
||||
```
|
||||
|
||||
**Example** (hex):
|
||||
```
|
||||
01 03 6d 63 63 6c 69 00 00 00 00
|
||||
01 00 00 00 00 00 00 00 6d 63 63 6c 69
|
||||
```
|
||||
|
||||
**Response**: `PACKET_OK` (0x00)
|
||||
**Response**: `PACKET_SELF_INFO` (0x05)
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -216,8 +216,6 @@ Byte 1: Channel Index (0-7)
|
|||
|
||||
**Response**: `PACKET_CHANNEL_INFO` (0x12) with channel details
|
||||
|
||||
**Note**: The device does not return channel secrets for security reasons. Store secrets locally when creating channels.
|
||||
|
||||
---
|
||||
|
||||
### 4. Set Channel
|
||||
|
|
@ -229,10 +227,10 @@ Byte 1: Channel Index (0-7)
|
|||
Byte 0: 0x20
|
||||
Byte 1: Channel Index (0-7)
|
||||
Bytes 2-33: Channel Name (32 bytes, UTF-8, null-padded)
|
||||
Bytes 34-65: Secret (32 bytes)
|
||||
Bytes 34-49: Secret (16 bytes)
|
||||
```
|
||||
|
||||
**Total Length**: 66 bytes
|
||||
**Total Length**: 50 bytes
|
||||
|
||||
**Channel Index**:
|
||||
- Index 0: Reserved for public channels (no secret)
|
||||
|
|
@ -243,16 +241,18 @@ Bytes 34-65: Secret (32 bytes)
|
|||
- Maximum 32 bytes
|
||||
- Padded with null bytes (0x00) if shorter
|
||||
|
||||
**Secret Field** (32 bytes):
|
||||
- For **private channels**: 32-byte secret
|
||||
**Secret Field** (16 bytes):
|
||||
- For **private channels**: 16-byte secret
|
||||
- For **public channels**: All zeros (0x00)
|
||||
|
||||
**Example** (create channel "YourChannelName" at index 1 with secret):
|
||||
```
|
||||
20 01 53 4D 53 00 00 ... (name padded to 32 bytes)
|
||||
[32 bytes of secret]
|
||||
[16 bytes of secret]
|
||||
```
|
||||
|
||||
**Note**: The 32-byte secret variant is unsupported and returns `PACKET_ERROR`.
|
||||
|
||||
**Response**: `PACKET_OK` (0x00) on success, `PACKET_ERROR` (0x01) on failure
|
||||
|
||||
---
|
||||
|
|
@ -304,9 +304,9 @@ Byte 0: 0x0A
|
|||
|
||||
---
|
||||
|
||||
### 7. Get Battery
|
||||
### 7. Get Battery and Storage
|
||||
|
||||
**Purpose**: Query device battery level.
|
||||
**Purpose**: Query device battery voltage and storage usage.
|
||||
|
||||
**Command Format**:
|
||||
```
|
||||
|
|
@ -318,7 +318,7 @@ Byte 0: 0x14
|
|||
14
|
||||
```
|
||||
|
||||
**Response**: `PACKET_BATTERY` (0x0C) with battery percentage
|
||||
**Response**: `PACKET_BATTERY` (0x0C) with battery millivolts and storage information
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -346,7 +346,7 @@ Byte 0: 0x14
|
|||
1. **Set Channel**:
|
||||
- Fetch all channel slots, and find one with empty name and all-zero secret
|
||||
- Generate or provide a 16-byte secret
|
||||
- Send `CMD_SET_CHANNEL` with name and secret
|
||||
- Send `CMD_SET_CHANNEL` with name and a 16-byte secret
|
||||
2. **Get Channel**:
|
||||
- Send `CMD_GET_CHANNEL` with channel index
|
||||
- Parse `RESP_CODE_CHANNEL_INFO` response
|
||||
|
|
@ -360,7 +360,7 @@ Byte 0: 0x14
|
|||
|
||||
### Receiving Messages
|
||||
|
||||
Messages are received via the RX characteristic (notifications). The device sends:
|
||||
Messages are received via the TX characteristic (notifications). The device sends:
|
||||
|
||||
1. **Channel Messages**:
|
||||
- `PACKET_CHANNEL_MSG_RECV` (0x08) - Standard format
|
||||
|
|
@ -544,10 +544,10 @@ Byte 1: Error code (optional)
|
|||
Byte 0: 0x12
|
||||
Byte 1: Channel Index
|
||||
Bytes 2-33: Channel Name (32 bytes, null-terminated)
|
||||
Bytes 34-65: Secret (32 bytes, but device typically only returns 20 bytes total)
|
||||
Bytes 34-49: Secret (16 bytes)
|
||||
```
|
||||
|
||||
**Note**: The device may not return the full 66-byte packet. Parse what is available. The secret field is typically not returned for security reasons.
|
||||
**Note**: The device returns the 16-byte channel secret in this response.
|
||||
|
||||
**PACKET_DEVICE_INFO** (0x0D):
|
||||
```
|
||||
|
|
@ -562,6 +562,8 @@ Bytes 4-7: BLE PIN (32-bit little-endian)
|
|||
Bytes 8-19: Firmware Build (12 bytes, UTF-8, null-padded)
|
||||
Bytes 20-59: Model (40 bytes, UTF-8, null-padded)
|
||||
Bytes 60-79: Version (20 bytes, UTF-8, null-padded)
|
||||
Byte 80: Client repeat enabled/preferred (firmware v9+)
|
||||
Byte 81: Path hash mode (firmware v10+)
|
||||
```
|
||||
|
||||
**Parsing Pseudocode**:
|
||||
|
|
@ -587,9 +589,7 @@ def parse_device_info(data):
|
|||
**PACKET_BATTERY** (0x0C):
|
||||
```
|
||||
Byte 0: 0x0C
|
||||
Bytes 1-2: Battery Level (16-bit little-endian, percentage 0-100)
|
||||
|
||||
Optional (if data size > 3):
|
||||
Bytes 1-2: Battery Voltage (16-bit little-endian, millivolts)
|
||||
Bytes 3-6: Used Storage (32-bit little-endian, KB)
|
||||
Bytes 7-10: Total Storage (32-bit little-endian, KB)
|
||||
```
|
||||
|
|
@ -600,14 +600,12 @@ def parse_battery(data):
|
|||
if len(data) < 3:
|
||||
return None
|
||||
|
||||
level = int.from_bytes(data[1:3], 'little')
|
||||
info = {'level': level}
|
||||
mv = int.from_bytes(data[1:3], 'little')
|
||||
info = {'battery_mv': mv}
|
||||
|
||||
if len(data) > 3:
|
||||
used_kb = int.from_bytes(data[3:7], 'little')
|
||||
total_kb = int.from_bytes(data[7:11], 'little')
|
||||
info['used_kb'] = used_kb
|
||||
info['total_kb'] = total_kb
|
||||
if len(data) >= 11:
|
||||
info['used_kb'] = int.from_bytes(data[3:7], 'little')
|
||||
info['total_kb'] = int.from_bytes(data[7:11], 'little')
|
||||
|
||||
return info
|
||||
```
|
||||
|
|
@ -629,7 +627,7 @@ Bytes 48-51: Radio Frequency (32-bit little-endian, divided by 1000.0)
|
|||
Bytes 52-55: Radio Bandwidth (32-bit little-endian, divided by 1000.0)
|
||||
Byte 56: Radio Spreading Factor
|
||||
Byte 57: Radio Coding Rate
|
||||
Bytes 58+: Device Name (UTF-8, variable length, null-terminated)
|
||||
Bytes 58+: Device Name (UTF-8, variable length, no null terminator required)
|
||||
```
|
||||
|
||||
**Parsing Pseudocode**:
|
||||
|
|
@ -680,9 +678,9 @@ def parse_self_info(data):
|
|||
**PACKET_MSG_SENT** (0x06):
|
||||
```
|
||||
Byte 0: 0x06
|
||||
Byte 1: Message Type
|
||||
Bytes 2-5: Expected ACK (4 bytes, hex)
|
||||
Bytes 6-9: Suggested Timeout (32-bit little-endian, seconds)
|
||||
Byte 1: Route Flag (0 = direct, 1 = flood)
|
||||
Bytes 2-5: Tag / Expected ACK (4 bytes, little-endian)
|
||||
Bytes 6-9: Suggested Timeout (32-bit little-endian, milliseconds)
|
||||
```
|
||||
|
||||
**PACKET_ACK** (0x82):
|
||||
|
|
@ -710,89 +708,32 @@ Bytes 1-6: ACK Code (6 bytes, hex)
|
|||
|
||||
**Note**: Error codes may vary by firmware version. Always check byte 1 of `PACKET_ERROR` response.
|
||||
|
||||
### Partial Packet Handling
|
||||
### Frame Handling
|
||||
|
||||
BLE notifications may arrive in chunks, especially for larger packets. Implement buffering:
|
||||
BLE implementations enqueue and deliver one protocol frame per BLE write/notification at the firmware layer.
|
||||
|
||||
**Implementation**:
|
||||
```python
|
||||
class PacketBuffer:
|
||||
def __init__(self):
|
||||
self.buffer = bytearray()
|
||||
self.expected_length = None
|
||||
|
||||
def add_data(self, data):
|
||||
self.buffer.extend(data)
|
||||
|
||||
# Check if we have a complete packet
|
||||
if len(self.buffer) >= 1:
|
||||
packet_type = self.buffer[0]
|
||||
|
||||
# Determine expected length based on packet type
|
||||
expected = self.get_expected_length(packet_type)
|
||||
|
||||
if expected is not None and len(self.buffer) >= expected:
|
||||
# Complete packet
|
||||
packet = bytes(self.buffer[:expected])
|
||||
self.buffer = self.buffer[expected:]
|
||||
return packet
|
||||
elif expected is None:
|
||||
# Variable length packet - try to parse what we have
|
||||
# Some packets have minimum length requirements
|
||||
if self.can_parse_partial(packet_type):
|
||||
return self.try_parse_partial()
|
||||
|
||||
return None # Incomplete packet
|
||||
|
||||
def get_expected_length(self, packet_type):
|
||||
# Fixed-length packets
|
||||
fixed_lengths = {
|
||||
0x00: 5, # PACKET_OK (minimum)
|
||||
0x01: 2, # PACKET_ERROR (minimum)
|
||||
0x0A: 1, # PACKET_NO_MORE_MSGS
|
||||
0x14: 3, # PACKET_BATTERY (minimum)
|
||||
}
|
||||
return fixed_lengths.get(packet_type)
|
||||
|
||||
def can_parse_partial(self, packet_type):
|
||||
# Some packets can be parsed partially
|
||||
return packet_type in [0x12, 0x08, 0x11, 0x07, 0x10, 0x05, 0x0D]
|
||||
|
||||
def try_parse_partial(self):
|
||||
# Try to parse with available data
|
||||
# Return packet if successfully parsed, None otherwise
|
||||
# This is packet-type specific
|
||||
pass
|
||||
```
|
||||
|
||||
**Usage**:
|
||||
```python
|
||||
buffer = PacketBuffer()
|
||||
|
||||
def on_notification_received(data):
|
||||
packet = buffer.add_data(data)
|
||||
if packet:
|
||||
parse_and_handle_packet(packet)
|
||||
```
|
||||
- Apps should treat each characteristic write/notification as exactly one companion protocol frame
|
||||
- Apps should still validate frame lengths before parsing
|
||||
- Future transports or firmware revisions may differ, so avoid assuming fixed payload sizes for variable-length responses
|
||||
|
||||
### Response Handling
|
||||
|
||||
1. **Command-Response Pattern**:
|
||||
- Send command via TX characteristic
|
||||
- Wait for response via RX characteristic (notification)
|
||||
- Send command via RX characteristic
|
||||
- Wait for response via TX characteristic (notification)
|
||||
- Match response to command using sequence numbers or command type
|
||||
- Handle timeout (typically 5 seconds)
|
||||
- Use command queue to prevent concurrent commands
|
||||
|
||||
2. **Asynchronous Messages**:
|
||||
- Device may send messages at any time via RX characteristic
|
||||
- Device may send messages at any time via TX characteristic
|
||||
- Handle `PACKET_MESSAGES_WAITING` (0x83) by polling `GET_MESSAGE` command
|
||||
- Parse incoming messages and route to appropriate handlers
|
||||
- Buffer partial packets until complete
|
||||
- Validate frame length before decoding
|
||||
|
||||
3. **Response Matching**:
|
||||
- Match responses to commands by expected packet type:
|
||||
- `APP_START` → `PACKET_OK`
|
||||
- `APP_START` → `PACKET_SELF_INFO`
|
||||
- `DEVICE_QUERY` → `PACKET_DEVICE_INFO`
|
||||
- `GET_CHANNEL` → `PACKET_CHANNEL_INFO`
|
||||
- `SET_CHANNEL` → `PACKET_OK` or `PACKET_ERROR`
|
||||
|
|
@ -825,16 +766,16 @@ device = scan_for_device("MeshCore")
|
|||
gatt = connect_to_device(device)
|
||||
|
||||
# 3. Discover services and characteristics
|
||||
service = discover_service(gatt, "0000ff00-0000-1000-8000-00805f9b34fb")
|
||||
rx_char = discover_characteristic(service, "0000ff01-0000-1000-8000-00805f9b34fb")
|
||||
tx_char = discover_characteristic(service, "0000ff02-0000-1000-8000-00805f9b34fb")
|
||||
service = discover_service(gatt, "6E400001-B5A3-F393-E0A9-E50E24DCCA9E")
|
||||
rx_char = discover_characteristic(service, "6E400002-B5A3-F393-E0A9-E50E24DCCA9E")
|
||||
tx_char = discover_characteristic(service, "6E400003-B5A3-F393-E0A9-E50E24DCCA9E")
|
||||
|
||||
# 4. Enable notifications on RX characteristic
|
||||
enable_notifications(rx_char, on_notification_received)
|
||||
# 4. Enable notifications on TX characteristic
|
||||
enable_notifications(tx_char, on_notification_received)
|
||||
|
||||
# 5. Send AppStart command
|
||||
send_command(tx_char, build_app_start())
|
||||
wait_for_response(PACKET_OK)
|
||||
send_command(rx_char, build_app_start())
|
||||
wait_for_response(PACKET_SELF_INFO)
|
||||
```
|
||||
|
||||
### Creating a Private Channel
|
||||
|
|
@ -844,21 +785,16 @@ wait_for_response(PACKET_OK)
|
|||
secret_16_bytes = generate_secret(16) # Use CSPRNG
|
||||
secret_hex = secret_16_bytes.hex()
|
||||
|
||||
# 2. Expand secret to 32 bytes using SHA-512
|
||||
import hashlib
|
||||
sha512_hash = hashlib.sha512(secret_16_bytes).digest()
|
||||
secret_32_bytes = sha512_hash[:32]
|
||||
|
||||
# 3. Build SET_CHANNEL command
|
||||
# 2. Build SET_CHANNEL command
|
||||
channel_name = "YourChannelName"
|
||||
channel_index = 1 # Use 1-7 for private channels
|
||||
command = build_set_channel(channel_index, channel_name, secret_32_bytes)
|
||||
command = build_set_channel(channel_index, channel_name, secret_16_bytes)
|
||||
|
||||
# 4. Send command
|
||||
send_command(tx_char, command)
|
||||
# 3. Send command
|
||||
send_command(rx_char, command)
|
||||
response = wait_for_response(PACKET_OK)
|
||||
|
||||
# 5. Store secret locally (device won't return it)
|
||||
# 4. Store secret locally
|
||||
store_channel_secret(channel_index, secret_hex)
|
||||
```
|
||||
|
||||
|
|
@ -872,7 +808,7 @@ timestamp = int(time.time())
|
|||
command = build_channel_message(channel_index, message, timestamp)
|
||||
|
||||
# 2. Send command
|
||||
send_command(tx_char, command)
|
||||
send_command(rx_char, command)
|
||||
response = wait_for_response(PACKET_MSG_SENT)
|
||||
```
|
||||
|
||||
|
|
@ -887,7 +823,7 @@ def on_notification_received(data):
|
|||
handle_channel_message(message)
|
||||
elif packet_type == PACKET_MESSAGES_WAITING:
|
||||
# Poll for messages
|
||||
send_command(tx_char, build_get_message())
|
||||
send_command(rx_char, build_get_message())
|
||||
```
|
||||
|
||||
---
|
||||
|
|
|
|||
10
docs/faq.md
10
docs/faq.md
|
|
@ -221,11 +221,11 @@ MeshCore allows you to manually broadcast your name, position and public encrypt
|
|||
* Zero hop means your advert is broadcasted out to anyone that can hear it, and that's it.
|
||||
* Flooded means it's broadcasted out and then repeated by all the repeaters that hear it.
|
||||
|
||||
MeshCore clients only advertise themselves when the user initiates it. A repeater sends a flood advert once every 3 hours by default. This interval can be configured using the following command:
|
||||
MeshCore clients only advertise themselves when the user initiates it. A repeater sends a flood advert once every 12 hours by default. This interval can be configured using the following command:
|
||||
|
||||
`set advert.interval {minutes}`
|
||||
`set flood.advert.interval {hours}`
|
||||
|
||||
As of Aug 20 2025, a pending PR on github will change the flood advert to 12 hours to minimize airtime utilization caused by repeaters' flood adverts.
|
||||
The separate `set advert.interval {minutes}` command controls the local zero-hop advert timer.
|
||||
|
||||
### 2.5. Q: Is there a hop limit?
|
||||
|
||||
|
|
@ -260,7 +260,9 @@ Repeater or room server can be administered with one of the options below:
|
|||
### 3.2. Q: Do I need to set the location for a repeater?
|
||||
**A:** While not required, with location set for a repeater it will show up on the MeshCore map in the future. Set location with the following command:
|
||||
|
||||
`set lat <GPS Lat> set long <GPS Lon>`
|
||||
`set lat <GPS Lat>`
|
||||
|
||||
`set lon <GPS Lon>`
|
||||
|
||||
You can get the latitude and longitude from Google Maps by right-clicking the location you are at on the map.
|
||||
|
||||
|
|
|
|||
|
|
@ -190,7 +190,7 @@ All values little-endian.
|
|||
| Field | Size | Description |
|
||||
|-------|------|-------------|
|
||||
| MAC | 2 bytes | HMAC-SHA256 truncated to 2 bytes |
|
||||
| Ciphertext | variable | AES-128-CBC encrypted data |
|
||||
| Ciphertext | variable | AES-128 block-encrypted data with zero padding |
|
||||
|
||||
### Airtime (Airtime response)
|
||||
|
||||
|
|
@ -268,7 +268,7 @@ Data returned in CayenneLPP format. See [CayenneLPP documentation](https://docs.
|
|||
|-----------|-----------|
|
||||
| Identity / Signing / Verification | Ed25519 |
|
||||
| Key Exchange | X25519 (ECDH) |
|
||||
| Encryption | AES-128-CBC + HMAC-SHA256 (MAC truncated to 2 bytes) |
|
||||
| Encryption | AES-128 block encryption with zero padding + HMAC-SHA256 (MAC truncated to 2 bytes) |
|
||||
| Hashing | SHA-256 |
|
||||
|
||||
## Notes
|
||||
|
|
@ -279,4 +279,4 @@ Data returned in CayenneLPP format. See [CayenneLPP documentation](https://docs.
|
|||
- SNR values in RxMeta are multiplied by 4 for 0.25 dB precision
|
||||
- TxDone is sent as a SetHardware event after each transmission
|
||||
- Standard KISS clients receive only type 0x00 data frames and can safely ignore all SetHardware (0x06) frames
|
||||
- See [packet_structure.md](./packet_structure.md) for packet format
|
||||
- See [packet_format.md](./packet_format.md) for packet format
|
||||
|
|
|
|||
|
|
@ -42,7 +42,7 @@ Shutdown reason codes (stored in GPREGRET2):
|
|||
| RAK WisMesh Tag | No | No | No |
|
||||
| Heltec Mesh Solar | No | No | No |
|
||||
| LilyGo T-Echo / T-Echo Lite | No | No | No |
|
||||
| SenseCAP Solar | No | No | No |
|
||||
| SenseCAP Solar | Yes | Yes | Yes |
|
||||
| WIO Tracker L1 / L1 E-Ink | No | No | No |
|
||||
| WIO WM1110 | No | No | No |
|
||||
| Mesh Pocket | No | No | No |
|
||||
|
|
|
|||
|
|
@ -90,23 +90,17 @@ Returned path messages provide a description of the route a packet took from the
|
|||
|
||||
## Request
|
||||
|
||||
| Field | Size (bytes) | Description |
|
||||
|--------------|-----------------|----------------------------|
|
||||
| timestamp | 4 | send time (unix timestamp) |
|
||||
| request type | 1 | see below |
|
||||
| request data | rest of payload | depends on request type |
|
||||
| Field | Size (bytes) | Description |
|
||||
|--------------|-----------------|------------------------------------------|
|
||||
| timestamp | 4 | sender time (unix timestamp) |
|
||||
| request data | rest of payload | application-defined request payload body |
|
||||
|
||||
Request type
|
||||
For the common chat/server helpers in `BaseChatMesh`, the current request type values are:
|
||||
|
||||
| Value | Name | Description |
|
||||
|--------|----------------------|---------------------------------------|
|
||||
| `0x01` | get stats | get stats of repeater or room server |
|
||||
| `0x02` | keepalive | (deprecated) |
|
||||
| `0x03` | get telemetry data | TODO |
|
||||
| `0x04` | get min,max,avg data | sensor nodes - get min, max, average for given time span |
|
||||
| `0x05` | get access list | get node's approved access list |
|
||||
| `0x06` | get neighbors | get repeater node's neighbors |
|
||||
| `0x07` | get owner info | get repeater firmware-ver/name/owner info |
|
||||
| `0x02` | keepalive | keep-alive request used for maintained connections |
|
||||
|
||||
### Get stats
|
||||
|
||||
|
|
@ -133,35 +127,36 @@ Gets information about the node, possibly including the following:
|
|||
|
||||
### Get telemetry data
|
||||
|
||||
Request data about sensors on the node, including battery level.
|
||||
Not defined in `BaseChatMesh`. Sensor- and application-specific request payloads may be implemented by higher-level firmware.
|
||||
|
||||
### Get Telemetry
|
||||
|
||||
TODO
|
||||
Not defined in `BaseChatMesh`.
|
||||
|
||||
### Get Min/Max/Ave (Sensor nodes)
|
||||
|
||||
TODO
|
||||
Not defined in `BaseChatMesh`.
|
||||
|
||||
### Get Access List
|
||||
|
||||
TODO
|
||||
Not defined in `BaseChatMesh`.
|
||||
|
||||
### Get Neighors
|
||||
|
||||
TODO
|
||||
Not defined in `BaseChatMesh`.
|
||||
|
||||
### Get Owner Info
|
||||
|
||||
TODO
|
||||
Not defined in `BaseChatMesh`.
|
||||
|
||||
|
||||
## Response
|
||||
|
||||
| Field | Size (bytes) | Description |
|
||||
|---------|-----------------|-------------|
|
||||
| tag | 4 | TODO |
|
||||
| content | rest of payload | TODO |
|
||||
| content | rest of payload | application-defined response body |
|
||||
|
||||
Response contents are opaque application data. There is no single generic response envelope beyond the encrypted payload wrapper shown above.
|
||||
|
||||
## Plain text message
|
||||
|
||||
|
|
|
|||
|
|
@ -1281,7 +1281,8 @@ void MyMesh::loop() {
|
|||
|
||||
if (next_flood_advert && millisHasNowPassed(next_flood_advert)) {
|
||||
mesh::Packet *pkt = createSelfAdvert();
|
||||
if (pkt) sendFlood(pkt);
|
||||
uint32_t delay_millis = 0;
|
||||
if (pkt) sendFlood(pkt, delay_millis, _prefs.path_hash_mode + 1);
|
||||
|
||||
updateFloodAdvertTimer(); // schedule next flood advert
|
||||
updateAdvertTimer(); // also schedule local advert (so they don't overlap)
|
||||
|
|
|
|||
|
|
@ -23,6 +23,11 @@ static char command[160];
|
|||
unsigned long lastActive = 0; // mark last active time
|
||||
unsigned long nextSleepinSecs = 120; // next sleep in seconds. The first sleep (if enabled) is after 2 minutes from boot
|
||||
|
||||
#if defined(PIN_USER_BTN) && defined(_SEEED_SENSECAP_SOLAR_H_)
|
||||
static unsigned long userBtnDownAt = 0;
|
||||
#define USER_BTN_HOLD_OFF_MILLIS 1500
|
||||
#endif
|
||||
|
||||
void setup() {
|
||||
Serial.begin(115200);
|
||||
delay(1000);
|
||||
|
|
@ -127,6 +132,21 @@ void loop() {
|
|||
command[0] = 0; // reset command buffer
|
||||
}
|
||||
|
||||
#if defined(PIN_USER_BTN) && defined(_SEEED_SENSECAP_SOLAR_H_)
|
||||
// Hold the user button to power off the SenseCAP Solar repeater.
|
||||
int btnState = digitalRead(PIN_USER_BTN);
|
||||
if (btnState == LOW) {
|
||||
if (userBtnDownAt == 0) {
|
||||
userBtnDownAt = millis();
|
||||
} else if ((unsigned long)(millis() - userBtnDownAt) >= USER_BTN_HOLD_OFF_MILLIS) {
|
||||
Serial.println("Powering off...");
|
||||
board.powerOff(); // does not return
|
||||
}
|
||||
} else {
|
||||
userBtnDownAt = 0;
|
||||
}
|
||||
#endif
|
||||
|
||||
the_mesh.loop();
|
||||
sensors.loop();
|
||||
#ifdef DISPLAY_CLASS
|
||||
|
|
|
|||
|
|
@ -858,7 +858,8 @@ void MyMesh::loop() {
|
|||
|
||||
if (next_flood_advert && millisHasNowPassed(next_flood_advert)) {
|
||||
mesh::Packet *pkt = createSelfAdvert();
|
||||
if (pkt) sendFlood(pkt);
|
||||
uint32_t delay_millis = 0;
|
||||
if (pkt) sendFlood(pkt, delay_millis, _prefs.path_hash_mode + 1);
|
||||
|
||||
updateFloodAdvertTimer(); // schedule next flood advert
|
||||
updateAdvertTimer(); // also schedule local advert (so they don't overlap)
|
||||
|
|
|
|||
|
|
@ -203,7 +203,9 @@ uint8_t CommonCLI::buildAdvertData(uint8_t node_type, uint8_t* app_data) {
|
|||
}
|
||||
|
||||
void CommonCLI::handleCommand(uint32_t sender_timestamp, const char* command, char* reply) {
|
||||
if (memcmp(command, "reboot", 6) == 0) {
|
||||
if (memcmp(command, "poweroff", 8) == 0 || memcmp(command, "shutdown", 8) == 0) {
|
||||
_board->powerOff(); // doesn't return
|
||||
} else if (memcmp(command, "reboot", 6) == 0) {
|
||||
_board->reboot(); // doesn't return
|
||||
} else if (memcmp(command, "clkreboot", 9) == 0) {
|
||||
// Reset clock
|
||||
|
|
|
|||
|
|
@ -59,44 +59,58 @@ bool E213Display::begin() {
|
|||
}
|
||||
|
||||
void E213Display::powerOn() {
|
||||
if (_periph_power) {
|
||||
_periph_power->claim();
|
||||
} else {
|
||||
#ifdef PIN_VEXT_EN
|
||||
pinMode(PIN_VEXT_EN, OUTPUT);
|
||||
pinMode(PIN_VEXT_EN, OUTPUT);
|
||||
#ifdef PIN_VEXT_EN_ACTIVE
|
||||
digitalWrite(PIN_VEXT_EN, PIN_VEXT_EN_ACTIVE);
|
||||
digitalWrite(PIN_VEXT_EN, PIN_VEXT_EN_ACTIVE);
|
||||
#else
|
||||
digitalWrite(PIN_VEXT_EN, LOW); // Active low
|
||||
digitalWrite(PIN_VEXT_EN, LOW); // Active low
|
||||
#endif
|
||||
#endif
|
||||
}
|
||||
delay(50); // Allow power to stabilize
|
||||
#endif
|
||||
}
|
||||
|
||||
void E213Display::powerOff() {
|
||||
if (_periph_power) {
|
||||
_periph_power->release();
|
||||
} else {
|
||||
#ifdef PIN_VEXT_EN
|
||||
#ifdef PIN_VEXT_EN_ACTIVE
|
||||
digitalWrite(PIN_VEXT_EN, !PIN_VEXT_EN_ACTIVE);
|
||||
digitalWrite(PIN_VEXT_EN, !PIN_VEXT_EN_ACTIVE);
|
||||
#else
|
||||
digitalWrite(PIN_VEXT_EN, HIGH); // Turn off power
|
||||
digitalWrite(PIN_VEXT_EN, HIGH); // Turn off power
|
||||
#endif
|
||||
#endif
|
||||
}
|
||||
}
|
||||
|
||||
void E213Display::turnOn() {
|
||||
if (!_init) begin();
|
||||
powerOn();
|
||||
else if (!_isOn) {
|
||||
powerOn();
|
||||
display->fastmodeOn(); // Reinitialize display controller after power was cut
|
||||
}
|
||||
_isOn = true;
|
||||
}
|
||||
|
||||
void E213Display::turnOff() {
|
||||
powerOff();
|
||||
_isOn = false;
|
||||
if (_isOn) {
|
||||
powerOff();
|
||||
_isOn = false;
|
||||
}
|
||||
}
|
||||
|
||||
void E213Display::clear() {
|
||||
display->clear();
|
||||
|
||||
}
|
||||
|
||||
void E213Display::startFrame(Color bkg) {
|
||||
display_crc.reset();
|
||||
|
||||
// Fill screen with white first to ensure clean background
|
||||
display->fillRect(0, 0, width(), height(), WHITE);
|
||||
|
||||
|
|
@ -107,31 +121,50 @@ void E213Display::startFrame(Color bkg) {
|
|||
}
|
||||
|
||||
void E213Display::setTextSize(int sz) {
|
||||
display_crc.update<int>(sz);
|
||||
// The library handles text size internally
|
||||
display->setTextSize(sz);
|
||||
}
|
||||
|
||||
void E213Display::setColor(Color c) {
|
||||
display_crc.update<Color>(c);
|
||||
// implemented in individual display methods
|
||||
}
|
||||
|
||||
void E213Display::setCursor(int x, int y) {
|
||||
display_crc.update<int>(x);
|
||||
display_crc.update<int>(y);
|
||||
display->setCursor(x, y);
|
||||
}
|
||||
|
||||
void E213Display::print(const char *str) {
|
||||
display_crc.update<char>(str, strlen(str));
|
||||
display->print(str);
|
||||
}
|
||||
|
||||
void E213Display::fillRect(int x, int y, int w, int h) {
|
||||
display_crc.update<int>(x);
|
||||
display_crc.update<int>(y);
|
||||
display_crc.update<int>(w);
|
||||
display_crc.update<int>(h);
|
||||
display->fillRect(x, y, w, h, BLACK);
|
||||
}
|
||||
|
||||
void E213Display::drawRect(int x, int y, int w, int h) {
|
||||
display_crc.update<int>(x);
|
||||
display_crc.update<int>(y);
|
||||
display_crc.update<int>(w);
|
||||
display_crc.update<int>(h);
|
||||
display->drawRect(x, y, w, h, BLACK);
|
||||
}
|
||||
|
||||
void E213Display::drawXbm(int x, int y, const uint8_t *bits, int w, int h) {
|
||||
display_crc.update<int>(x);
|
||||
display_crc.update<int>(y);
|
||||
display_crc.update<int>(w);
|
||||
display_crc.update<int>(h);
|
||||
display_crc.update<uint8_t>(bits, w * h / 8);
|
||||
|
||||
// Width in bytes for bitmap processing
|
||||
uint16_t widthInBytes = (w + 7) / 8;
|
||||
|
||||
|
|
@ -160,5 +193,9 @@ uint16_t E213Display::getTextWidth(const char *str) {
|
|||
}
|
||||
|
||||
void E213Display::endFrame() {
|
||||
uint32_t crc = display_crc.finalize();
|
||||
if (crc != last_display_crc_value) {
|
||||
display->update();
|
||||
last_display_crc_value = crc;
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -5,15 +5,20 @@
|
|||
#include <SPI.h>
|
||||
#include <Wire.h>
|
||||
#include <heltec-eink-modules.h>
|
||||
#include <CRC32.h>
|
||||
#include <helpers/RefCountedDigitalPin.h>
|
||||
|
||||
// Display driver for E213 e-ink display
|
||||
class E213Display : public DisplayDriver {
|
||||
BaseDisplay* display=NULL;
|
||||
bool _init = false;
|
||||
bool _isOn = false;
|
||||
RefCountedDigitalPin* _periph_power;
|
||||
CRC32 display_crc;
|
||||
uint32_t last_display_crc_value = 0;
|
||||
|
||||
public:
|
||||
E213Display() : DisplayDriver(250, 122) {}
|
||||
E213Display(RefCountedDigitalPin* periph_power = NULL) : DisplayDriver(250, 122), _periph_power(periph_power) {}
|
||||
~E213Display(){
|
||||
if(display!=NULL) {
|
||||
delete display;
|
||||
|
|
@ -39,4 +44,4 @@ private:
|
|||
BaseDisplay* detectEInk();
|
||||
void powerOn();
|
||||
void powerOff();
|
||||
};
|
||||
};
|
||||
|
|
|
|||
|
|
@ -21,28 +21,41 @@ bool E290Display::begin() {
|
|||
}
|
||||
|
||||
void E290Display::powerOn() {
|
||||
if (_periph_power) {
|
||||
_periph_power->claim();
|
||||
} else {
|
||||
#ifdef PIN_VEXT_EN
|
||||
pinMode(PIN_VEXT_EN, OUTPUT);
|
||||
digitalWrite(PIN_VEXT_EN, PIN_VEXT_EN_ACTIVE);
|
||||
delay(50); // Allow power to stabilize
|
||||
pinMode(PIN_VEXT_EN, OUTPUT);
|
||||
digitalWrite(PIN_VEXT_EN, PIN_VEXT_EN_ACTIVE);
|
||||
#endif
|
||||
}
|
||||
delay(50); // Allow power to stabilize
|
||||
}
|
||||
|
||||
void E290Display::powerOff() {
|
||||
if (_periph_power) {
|
||||
_periph_power->release();
|
||||
} else {
|
||||
#ifdef PIN_VEXT_EN
|
||||
digitalWrite(PIN_VEXT_EN, !PIN_VEXT_EN_ACTIVE); // Turn off power
|
||||
digitalWrite(PIN_VEXT_EN, !PIN_VEXT_EN_ACTIVE); // Turn off power
|
||||
#endif
|
||||
}
|
||||
}
|
||||
|
||||
void E290Display::turnOn() {
|
||||
if (!_init) begin();
|
||||
powerOn();
|
||||
else if (!_isOn) {
|
||||
powerOn();
|
||||
display.fastmodeOn(); // Reinitialize display controller after power was cut
|
||||
}
|
||||
_isOn = true;
|
||||
}
|
||||
|
||||
void E290Display::turnOff() {
|
||||
powerOff();
|
||||
_isOn = false;
|
||||
if (_isOn) {
|
||||
powerOff();
|
||||
_isOn = false;
|
||||
}
|
||||
}
|
||||
|
||||
void E290Display::clear() {
|
||||
|
|
@ -50,6 +63,8 @@ void E290Display::clear() {
|
|||
}
|
||||
|
||||
void E290Display::startFrame(Color bkg) {
|
||||
display_crc.reset();
|
||||
|
||||
// Fill screen with white first to ensure clean background
|
||||
display.fillRect(0, 0, width(), height(), WHITE);
|
||||
if (bkg == LIGHT) {
|
||||
|
|
@ -59,31 +74,50 @@ void E290Display::startFrame(Color bkg) {
|
|||
}
|
||||
|
||||
void E290Display::setTextSize(int sz) {
|
||||
display_crc.update<int>(sz);
|
||||
// The library handles text size internally
|
||||
display.setTextSize(sz);
|
||||
}
|
||||
|
||||
void E290Display::setColor(Color c) {
|
||||
display_crc.update<Color>(c);
|
||||
// implemented in individual display methods
|
||||
}
|
||||
|
||||
void E290Display::setCursor(int x, int y) {
|
||||
display_crc.update<int>(x);
|
||||
display_crc.update<int>(y);
|
||||
display.setCursor(x, y);
|
||||
}
|
||||
|
||||
void E290Display::print(const char *str) {
|
||||
display_crc.update<char>(str, strlen(str));
|
||||
display.print(str);
|
||||
}
|
||||
|
||||
void E290Display::fillRect(int x, int y, int w, int h) {
|
||||
display_crc.update<int>(x);
|
||||
display_crc.update<int>(y);
|
||||
display_crc.update<int>(w);
|
||||
display_crc.update<int>(h);
|
||||
display.fillRect(x, y, w, h, BLACK);
|
||||
}
|
||||
|
||||
void E290Display::drawRect(int x, int y, int w, int h) {
|
||||
display_crc.update<int>(x);
|
||||
display_crc.update<int>(y);
|
||||
display_crc.update<int>(w);
|
||||
display_crc.update<int>(h);
|
||||
display.drawRect(x, y, w, h, BLACK);
|
||||
}
|
||||
|
||||
void E290Display::drawXbm(int x, int y, const uint8_t *bits, int w, int h) {
|
||||
display_crc.update<int>(x);
|
||||
display_crc.update<int>(y);
|
||||
display_crc.update<int>(w);
|
||||
display_crc.update<int>(h);
|
||||
display_crc.update<uint8_t>(bits, w * h / 8);
|
||||
|
||||
// Width in bytes for bitmap processing
|
||||
uint16_t widthInBytes = (w + 7) / 8;
|
||||
|
||||
|
|
@ -112,5 +146,9 @@ uint16_t E290Display::getTextWidth(const char *str) {
|
|||
}
|
||||
|
||||
void E290Display::endFrame() {
|
||||
display.update();
|
||||
uint32_t crc = display_crc.finalize();
|
||||
if (crc != last_display_crc_value) {
|
||||
display.update();
|
||||
last_display_crc_value = crc;
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -5,15 +5,20 @@
|
|||
#include <SPI.h>
|
||||
#include <Wire.h>
|
||||
#include <heltec-eink-modules.h>
|
||||
#include <CRC32.h>
|
||||
#include <helpers/RefCountedDigitalPin.h>
|
||||
|
||||
// Display driver for E290 e-ink display
|
||||
class E290Display : public DisplayDriver {
|
||||
EInkDisplay_VisionMasterE290 display;
|
||||
bool _init = false;
|
||||
bool _isOn = false;
|
||||
RefCountedDigitalPin* _periph_power;
|
||||
CRC32 display_crc;
|
||||
uint32_t last_display_crc_value = 0;
|
||||
|
||||
public:
|
||||
E290Display() : DisplayDriver(296, 128) {}
|
||||
E290Display(RefCountedDigitalPin* periph_power = NULL) : DisplayDriver(296, 128), _periph_power(periph_power) {}
|
||||
|
||||
bool begin();
|
||||
bool isOn() override { return _isOn; }
|
||||
|
|
@ -34,4 +39,4 @@ public:
|
|||
private:
|
||||
void powerOn();
|
||||
void powerOff();
|
||||
};
|
||||
};
|
||||
|
|
|
|||
57
variants/gat562_30s_mesh_kit/GAT56230SMeshKitBoard.cpp
Normal file
57
variants/gat562_30s_mesh_kit/GAT56230SMeshKitBoard.cpp
Normal file
|
|
@ -0,0 +1,57 @@
|
|||
#include <Arduino.h>
|
||||
#include <Wire.h>
|
||||
|
||||
#include "GAT56230SMeshKitBoard.h"
|
||||
|
||||
|
||||
#ifdef NRF52_POWER_MANAGEMENT
|
||||
// Static configuration for power management
|
||||
// Values set in variant.h defines
|
||||
const PowerMgtConfig power_config = {
|
||||
.lpcomp_ain_channel = PWRMGT_LPCOMP_AIN,
|
||||
.lpcomp_refsel = PWRMGT_LPCOMP_REFSEL,
|
||||
.voltage_bootlock = PWRMGT_VOLTAGE_BOOTLOCK
|
||||
};
|
||||
|
||||
|
||||
void GAT56230SMeshKitBoard::initiateShutdown(uint8_t reason) {
|
||||
// Disable LoRa module power before shutdown
|
||||
digitalWrite(SX126X_POWER_EN, LOW);
|
||||
|
||||
if (reason == SHUTDOWN_REASON_LOW_VOLTAGE ||
|
||||
reason == SHUTDOWN_REASON_BOOT_PROTECT) {
|
||||
configureVoltageWake(power_config.lpcomp_ain_channel, power_config.lpcomp_refsel);
|
||||
}
|
||||
|
||||
enterSystemOff(reason);
|
||||
}
|
||||
#endif // NRF52_POWER_MANAGEMENT
|
||||
|
||||
|
||||
void GAT56230SMeshKitBoard::begin() {
|
||||
NRF52BoardDCDC::begin();
|
||||
pinMode(PIN_VBAT_READ, INPUT);
|
||||
|
||||
// Set all button pins to INPUT_PULLUP
|
||||
pinMode(PIN_BUTTON1, INPUT_PULLUP);
|
||||
pinMode(PIN_BUTTON2, INPUT_PULLUP);
|
||||
pinMode(PIN_BUTTON3, INPUT_PULLUP);
|
||||
pinMode(PIN_BUTTON4, INPUT_PULLUP);
|
||||
pinMode(PIN_BUTTON5, INPUT_PULLUP);
|
||||
pinMode(PIN_BUTTON6, INPUT_PULLUP);
|
||||
|
||||
#if defined(PIN_BOARD_SDA) && defined(PIN_BOARD_SCL)
|
||||
Wire.setPins(PIN_BOARD_SDA, PIN_BOARD_SCL);
|
||||
#endif
|
||||
|
||||
Wire.begin();
|
||||
|
||||
pinMode(SX126X_POWER_EN, OUTPUT);
|
||||
#ifdef NRF52_POWER_MANAGEMENT
|
||||
// Boot voltage protection check (may not return if voltage too low)
|
||||
// We need to call this after we configure SX126X_POWER_EN as output but before we pull high
|
||||
checkBootVoltage(&power_config);
|
||||
#endif
|
||||
digitalWrite(SX126X_POWER_EN, HIGH);
|
||||
delay(10); // give sx1262 some time to power up
|
||||
}
|
||||
53
variants/gat562_30s_mesh_kit/GAT56230SMeshKitBoard.h
Normal file
53
variants/gat562_30s_mesh_kit/GAT56230SMeshKitBoard.h
Normal file
|
|
@ -0,0 +1,53 @@
|
|||
#pragma once
|
||||
|
||||
#include <MeshCore.h>
|
||||
#include <Arduino.h>
|
||||
#include <helpers/NRF52Board.h>
|
||||
|
||||
|
||||
class GAT56230SMeshKitBoard : public NRF52BoardDCDC {
|
||||
protected:
|
||||
#ifdef NRF52_POWER_MANAGEMENT
|
||||
void initiateShutdown(uint8_t reason) override;
|
||||
#endif
|
||||
|
||||
public:
|
||||
GAT56230SMeshKitBoard() : NRF52Board("GAT562_OTA") {}
|
||||
void begin();
|
||||
|
||||
#define BATTERY_SAMPLES 8
|
||||
|
||||
uint16_t getBattMilliVolts() override {
|
||||
analogReadResolution(12);
|
||||
|
||||
uint32_t raw = 0;
|
||||
for (int i = 0; i < BATTERY_SAMPLES; i++) {
|
||||
raw += analogRead(PIN_VBAT_READ);
|
||||
}
|
||||
raw = raw / BATTERY_SAMPLES;
|
||||
|
||||
return (ADC_MULTIPLIER * raw) / 4096;
|
||||
}
|
||||
|
||||
const char* getManufacturerName() const override {
|
||||
return "GAT562 30S Mesh Kit";
|
||||
}
|
||||
|
||||
#if defined(P_LORA_TX_LED)
|
||||
void onBeforeTransmit() override {
|
||||
digitalWrite(P_LORA_TX_LED, HIGH); // turn TX LED on
|
||||
}
|
||||
|
||||
void onAfterTransmit() override {
|
||||
digitalWrite(P_LORA_TX_LED, LOW); // turn TX LED off
|
||||
}
|
||||
#endif
|
||||
|
||||
void powerOff() override {
|
||||
uint32_t button_pin = PIN_BUTTON1;
|
||||
nrf_gpio_cfg_input(button_pin, NRF_GPIO_PIN_PULLUP);
|
||||
nrf_gpio_cfg_sense_set(button_pin, NRF_GPIO_PIN_SENSE_LOW);
|
||||
sd_power_system_off();
|
||||
}
|
||||
|
||||
};
|
||||
114
variants/gat562_30s_mesh_kit/platformio.ini
Normal file
114
variants/gat562_30s_mesh_kit/platformio.ini
Normal file
|
|
@ -0,0 +1,114 @@
|
|||
[GAT562_30S_Mesh_Kit]
|
||||
extends = nrf52_base
|
||||
board = rak4631
|
||||
board_check = true
|
||||
build_flags = ${nrf52_base.build_flags}
|
||||
${sensor_base.build_flags}
|
||||
-I variants/gat562_30s_mesh_kit
|
||||
-D RAK_4631
|
||||
-D RAK_BOARD
|
||||
-D NRF52_POWER_MANAGEMENT
|
||||
-D PIN_BOARD_SCL=14
|
||||
-D PIN_BOARD_SDA=13
|
||||
-D PIN_OLED_RESET=-1
|
||||
-D UI_HAS_JOYSTICK=1
|
||||
-D RADIO_CLASS=CustomSX1262
|
||||
-D WRAPPER_CLASS=CustomSX1262Wrapper
|
||||
-D LORA_TX_POWER=22
|
||||
-D SX126X_CURRENT_LIMIT=140
|
||||
-D PIN_BUZZER=33
|
||||
-D SX126X_RX_BOOSTED_GAIN=1
|
||||
-D SX126X_DIO2_AS_RF_SWITCH=true
|
||||
build_src_filter = ${nrf52_base.build_src_filter}
|
||||
+<../variants/gat562_30s_mesh_kit>
|
||||
+<helpers/ui/SSD1306Display.cpp>
|
||||
+<helpers/ui/MomentaryButton.cpp>
|
||||
+<helpers/sensors>
|
||||
lib_deps =
|
||||
${nrf52_base.lib_deps}
|
||||
${sensor_base.lib_deps}
|
||||
adafruit/Adafruit SSD1306 @ ^2.5.13
|
||||
sparkfun/SparkFun u-blox GNSS Arduino Library@^2.2.27
|
||||
|
||||
|
||||
[env:GAT562_30S_Mesh_Kit_repeater]
|
||||
extends = GAT562_30S_Mesh_Kit
|
||||
build_flags =
|
||||
${GAT562_30S_Mesh_Kit.build_flags}
|
||||
-D DISPLAY_CLASS=SSD1306Display
|
||||
-D ADVERT_NAME='"GAT562 Repeater"'
|
||||
-D ADVERT_LAT=0.0
|
||||
-D ADVERT_LON=0.0
|
||||
-D ADMIN_PASSWORD='"password"'
|
||||
-D MAX_NEIGHBOURS=50
|
||||
; -D MESH_PACKET_LOGGING=1
|
||||
; -D MESH_DEBUG=1
|
||||
build_src_filter = ${GAT562_30S_Mesh_Kit.build_src_filter}
|
||||
+<helpers/ui/SSD1306Display.cpp>
|
||||
+<../examples/simple_repeater>
|
||||
|
||||
|
||||
[env:GAT562_30S_Mesh_Kit_room_server]
|
||||
extends = GAT562_30S_Mesh_Kit
|
||||
build_flags =
|
||||
${GAT562_30S_Mesh_Kit.build_flags}
|
||||
-D DISPLAY_CLASS=SSD1306Display
|
||||
-D ADVERT_NAME='"GAT562 Room"'
|
||||
-D ADVERT_LAT=0.0
|
||||
-D ADVERT_LON=0.0
|
||||
-D ADMIN_PASSWORD='"password"'
|
||||
-D ROOM_PASSWORD='"hello"'
|
||||
; -D MESH_PACKET_LOGGING=1
|
||||
; -D MESH_DEBUG=1
|
||||
build_src_filter = ${GAT562_30S_Mesh_Kit.build_src_filter}
|
||||
+<helpers/ui/SSD1306Display.cpp>
|
||||
+<../examples/simple_room_server>
|
||||
|
||||
|
||||
[env:GAT562_30S_Mesh_Kit_companion_radio_usb]
|
||||
extends = GAT562_30S_Mesh_Kit
|
||||
board_build.ldscript = boards/nrf52840_s140_v6_extrafs.ld
|
||||
board_upload.maximum_size = 712704
|
||||
build_flags =
|
||||
${GAT562_30S_Mesh_Kit.build_flags}
|
||||
-I examples/companion_radio/ui-new
|
||||
-D DISPLAY_CLASS=SSD1306Display
|
||||
-D MAX_CONTACTS=350
|
||||
-D MAX_GROUP_CHANNELS=40
|
||||
; NOTE: DO NOT ENABLE --> -D MESH_PACKET_LOGGING=1
|
||||
; NOTE: DO NOT ENABLE --> -D MESH_DEBUG=1
|
||||
build_src_filter = ${GAT562_30S_Mesh_Kit.build_src_filter}
|
||||
+<../examples/companion_radio/*.cpp>
|
||||
+<../examples/companion_radio/ui-new/*.cpp>
|
||||
+<helpers/ui/buzzer.cpp>
|
||||
lib_deps =
|
||||
${GAT562_30S_Mesh_Kit.lib_deps}
|
||||
densaugeo/base64 @ ~1.4.0
|
||||
end2endzone/NonBlockingRTTTL@^1.3.0
|
||||
|
||||
|
||||
[env:GAT562_30S_Mesh_Kit_companion_radio_ble]
|
||||
extends = GAT562_30S_Mesh_Kit
|
||||
board_build.ldscript = boards/nrf52840_s140_v6_extrafs.ld
|
||||
board_upload.maximum_size = 712704
|
||||
build_flags =
|
||||
${GAT562_30S_Mesh_Kit.build_flags}
|
||||
-I examples/companion_radio/ui-new
|
||||
-D DISPLAY_CLASS=SSD1306Display
|
||||
-D MAX_CONTACTS=350
|
||||
-D MAX_GROUP_CHANNELS=40
|
||||
-D BLE_PIN_CODE=123456
|
||||
-D BLE_DEBUG_LOGGING=1
|
||||
-D OFFLINE_QUEUE_SIZE=256
|
||||
; -D MESH_PACKET_LOGGING=1
|
||||
; -D MESH_DEBUG=1
|
||||
build_src_filter = ${GAT562_30S_Mesh_Kit.build_src_filter}
|
||||
+<helpers/nrf52/SerialBLEInterface.cpp>
|
||||
+<helpers/ui/buzzer.cpp>
|
||||
+<../examples/companion_radio/*.cpp>
|
||||
+<../examples/companion_radio/ui-new/*.cpp>
|
||||
lib_deps =
|
||||
${GAT562_30S_Mesh_Kit.lib_deps}
|
||||
densaugeo/base64 @ ~1.4.0
|
||||
end2endzone/NonBlockingRTTTL@^1.3.0
|
||||
|
||||
59
variants/gat562_30s_mesh_kit/target.cpp
Normal file
59
variants/gat562_30s_mesh_kit/target.cpp
Normal file
|
|
@ -0,0 +1,59 @@
|
|||
#include <Arduino.h>
|
||||
#include "target.h"
|
||||
#include <helpers/ArduinoHelpers.h>
|
||||
|
||||
GAT56230SMeshKitBoard board;
|
||||
|
||||
#ifndef PIN_USER_BTN
|
||||
#define PIN_USER_BTN (-1)
|
||||
#endif
|
||||
|
||||
|
||||
#ifdef DISPLAY_CLASS
|
||||
DISPLAY_CLASS display;
|
||||
MomentaryButton user_btn(PIN_USER_BTN, 1000, true, false, false);
|
||||
MomentaryButton joystick_left(JOYSTICK_LEFT, 1000, true, false, false);
|
||||
MomentaryButton joystick_right(JOYSTICK_RIGHT, 1000, true, false, false);
|
||||
MomentaryButton back_btn(PIN_BACK_BTN, 1000, true, false, true);
|
||||
#endif
|
||||
|
||||
|
||||
RADIO_CLASS radio = new Module(P_LORA_NSS, P_LORA_DIO_1, P_LORA_RESET, P_LORA_BUSY, SPI);
|
||||
|
||||
WRAPPER_CLASS radio_driver(radio, board);
|
||||
|
||||
VolatileRTCClock fallback_clock;
|
||||
AutoDiscoverRTCClock rtc_clock(fallback_clock);
|
||||
|
||||
#if ENV_INCLUDE_GPS
|
||||
#include <helpers/sensors/MicroNMEALocationProvider.h>
|
||||
MicroNMEALocationProvider nmea = MicroNMEALocationProvider(Serial1, &rtc_clock);
|
||||
EnvironmentSensorManager sensors = EnvironmentSensorManager(nmea);
|
||||
#else
|
||||
EnvironmentSensorManager sensors;
|
||||
#endif
|
||||
|
||||
bool radio_init() {
|
||||
rtc_clock.begin(Wire);
|
||||
return radio.std_init(&SPI);
|
||||
}
|
||||
|
||||
uint32_t radio_get_rng_seed() {
|
||||
return radio.random(0x7FFFFFFF);
|
||||
}
|
||||
|
||||
void radio_set_params(float freq, float bw, uint8_t sf, uint8_t cr) {
|
||||
radio.setFrequency(freq);
|
||||
radio.setSpreadingFactor(sf);
|
||||
radio.setBandwidth(bw);
|
||||
radio.setCodingRate(cr);
|
||||
}
|
||||
|
||||
void radio_set_tx_power(int8_t dbm) {
|
||||
radio.setOutputPower(dbm);
|
||||
}
|
||||
|
||||
mesh::LocalIdentity radio_new_identity() {
|
||||
RadioNoiseListener rng(radio);
|
||||
return mesh::LocalIdentity(&rng); // create new random identity
|
||||
}
|
||||
30
variants/gat562_30s_mesh_kit/target.h
Normal file
30
variants/gat562_30s_mesh_kit/target.h
Normal file
|
|
@ -0,0 +1,30 @@
|
|||
#pragma once
|
||||
|
||||
#define RADIOLIB_STATIC_ONLY 1
|
||||
#include <RadioLib.h>
|
||||
#include <helpers/radiolib/RadioLibWrappers.h>
|
||||
#include <GAT56230SMeshKitBoard.h>
|
||||
#include <helpers/radiolib/CustomSX1262Wrapper.h>
|
||||
#include <helpers/AutoDiscoverRTCClock.h>
|
||||
#include <helpers/sensors/EnvironmentSensorManager.h>
|
||||
|
||||
#ifdef DISPLAY_CLASS
|
||||
#include <helpers/ui/SSD1306Display.h>
|
||||
extern DISPLAY_CLASS display;
|
||||
#include <helpers/ui/MomentaryButton.h>
|
||||
extern MomentaryButton user_btn;
|
||||
extern MomentaryButton joystick_left;
|
||||
extern MomentaryButton joystick_right;
|
||||
extern MomentaryButton back_btn;
|
||||
#endif
|
||||
|
||||
extern GAT56230SMeshKitBoard board;
|
||||
extern WRAPPER_CLASS radio_driver;
|
||||
extern AutoDiscoverRTCClock rtc_clock;
|
||||
extern EnvironmentSensorManager sensors;
|
||||
|
||||
bool radio_init();
|
||||
uint32_t radio_get_rng_seed();
|
||||
void radio_set_params(float freq, float bw, uint8_t sf, uint8_t cr);
|
||||
void radio_set_tx_power(int8_t dbm);
|
||||
mesh::LocalIdentity radio_new_identity();
|
||||
49
variants/gat562_30s_mesh_kit/variant.cpp
Normal file
49
variants/gat562_30s_mesh_kit/variant.cpp
Normal file
|
|
@ -0,0 +1,49 @@
|
|||
/*
|
||||
Copyright (c) 2014-2015 Arduino LLC. All right reserved.
|
||||
Copyright (c) 2016 Sandeep Mistry All right reserved.
|
||||
Copyright (c) 2018, Adafruit Industries (adafruit.com)
|
||||
|
||||
This library is free software; you can redistribute it and/or
|
||||
modify it under the terms of the GNU Lesser General Public
|
||||
License as published by the Free Software Foundation; either
|
||||
version 2.1 of the License, or (at your option) any later version.
|
||||
|
||||
This library is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
|
||||
See the GNU Lesser General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU Lesser General Public
|
||||
License along with this library; if not, write to the Free Software
|
||||
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
|
||||
*/
|
||||
|
||||
#include "variant.h"
|
||||
#include "wiring_constants.h"
|
||||
#include "wiring_digital.h"
|
||||
#include "nrf.h"
|
||||
|
||||
const uint32_t g_ADigitalPinMap[] =
|
||||
{
|
||||
// P0
|
||||
0 , 1 , 2 , 3 , 4 , 5 , 6 , 7 ,
|
||||
8 , 9 , 10, 11, 12, 13, 14, 15,
|
||||
16, 17, 18, 19, 20, 21, 22, 23,
|
||||
24, 25, 26, 27, 28, 29, 30, 31,
|
||||
|
||||
// P1
|
||||
32, 33, 34, 35, 36, 37, 38, 39,
|
||||
40, 41, 42, 43, 44, 45, 46, 47
|
||||
};
|
||||
|
||||
|
||||
void initVariant()
|
||||
{
|
||||
// LED1 & LED2
|
||||
pinMode(PIN_LED1, OUTPUT);
|
||||
ledOff(PIN_LED1);
|
||||
|
||||
// pinMode(PIN_LED2, OUTPUT);
|
||||
// ledOff(PIN_LED2);;
|
||||
}
|
||||
|
||||
230
variants/gat562_30s_mesh_kit/variant.h
Normal file
230
variants/gat562_30s_mesh_kit/variant.h
Normal file
|
|
@ -0,0 +1,230 @@
|
|||
/*
|
||||
Copyright (c) 2014-2015 Arduino LLC. All right reserved.
|
||||
Copyright (c) 2016 Sandeep Mistry All right reserved.
|
||||
Copyright (c) 2018, Adafruit Industries (adafruit.com)
|
||||
|
||||
This library is free software; you can redistribute it and/or
|
||||
modify it under the terms of the GNU Lesser General Public
|
||||
License as published by the Free Software Foundation; either
|
||||
version 2.1 of the License, or (at your option) any later version.
|
||||
This library is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
|
||||
See the GNU Lesser General Public License for more details.
|
||||
You should have received a copy of the GNU Lesser General Public
|
||||
License along with this library; if not, write to the Free Software
|
||||
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
|
||||
*/
|
||||
|
||||
#ifndef _VARIANT_RAK4630_
|
||||
#define _VARIANT_RAK4630_
|
||||
|
||||
#define RAK4630
|
||||
|
||||
/** Master clock frequency */
|
||||
#define VARIANT_MCK (64000000ul)
|
||||
|
||||
#define USE_LFXO // Board uses 32khz crystal for LF
|
||||
// define USE_LFRC // Board uses RC for LF
|
||||
|
||||
/*----------------------------------------------------------------------------
|
||||
* Headers
|
||||
*----------------------------------------------------------------------------*/
|
||||
|
||||
#include "WVariant.h"
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C"
|
||||
{
|
||||
#endif // __cplusplus
|
||||
|
||||
/*
|
||||
* WisBlock Base GPIO definitions
|
||||
*/
|
||||
static const uint8_t WB_IO1 = 17; // SLOT_A SLOT_B
|
||||
static const uint8_t WB_IO2 = 34; // SLOT_A SLOT_B
|
||||
static const uint8_t WB_IO3 = 21; // SLOT_C
|
||||
static const uint8_t WB_IO4 = 4; // SLOT_C
|
||||
static const uint8_t WB_IO5 = 9; // SLOT_D
|
||||
static const uint8_t WB_IO6 = 10; // SLOT_D
|
||||
static const uint8_t WB_SW1 = 33; // IO_SLOT
|
||||
static const uint8_t WB_A0 = 5; // IO_SLOT
|
||||
static const uint8_t WB_A1 = 31; // IO_SLOT
|
||||
static const uint8_t WB_I2C1_SDA = 13; // SENSOR_SLOT IO_SLOT
|
||||
static const uint8_t WB_I2C1_SCL = 14; // SENSOR_SLOT IO_SLOT
|
||||
static const uint8_t WB_I2C2_SDA = 24; // IO_SLOT
|
||||
static const uint8_t WB_I2C2_SCL = 25; // IO_SLOT
|
||||
static const uint8_t WB_SPI_CS = 26; // IO_SLOT
|
||||
static const uint8_t WB_SPI_CLK = 3; // IO_SLOT
|
||||
static const uint8_t WB_SPI_MISO = 29; // IO_SLOT
|
||||
static const uint8_t WB_SPI_MOSI = 30; // IO_SLOT
|
||||
|
||||
// Number of pins defined in PinDescription array
|
||||
#define PINS_COUNT (48)
|
||||
#define NUM_DIGITAL_PINS (48)
|
||||
#define NUM_ANALOG_INPUTS (6)
|
||||
#define NUM_ANALOG_OUTPUTS (0)
|
||||
|
||||
// LEDs
|
||||
#define PIN_LED1 (35)
|
||||
#define PIN_LED2 (36)
|
||||
#define PIN_LED3 (29)
|
||||
|
||||
#define LED_BUILTIN PIN_LED1
|
||||
#define LED_CONN PIN_LED2
|
||||
#define WS2812_PIN PIN_LED3
|
||||
|
||||
#define LED_GREEN PIN_LED1
|
||||
#define LED_BLUE PIN_LED2
|
||||
|
||||
#define LED_STATE_ON 1 // State when LED is litted
|
||||
|
||||
#define P_LORA_TX_LED LED_GREEN
|
||||
|
||||
|
||||
/*
|
||||
* Buttons
|
||||
*/
|
||||
#define PIN_BUTTON1 (9) // Menu / User Button
|
||||
#define PIN_BUTTON2 (28) // Joystick Up
|
||||
#define PIN_BUTTON3 (4) // Joystick Down
|
||||
#define PIN_BUTTON4 (30) // Joystick Left
|
||||
#define PIN_BUTTON5 (31) // Joystick Right
|
||||
#define PIN_BUTTON6 (26) // Joystick Press
|
||||
#define PIN_BACK_BTN PIN_BUTTON1
|
||||
#define JOYSTICK_UP PIN_BUTTON2
|
||||
#define JOYSTICK_DOWN PIN_BUTTON3
|
||||
#define JOYSTICK_LEFT PIN_BUTTON4
|
||||
#define JOYSTICK_RIGHT PIN_BUTTON5
|
||||
#define JOYSTICK_PRESS PIN_BUTTON6
|
||||
#define PIN_USER_BTN PIN_BUTTON6
|
||||
|
||||
/*
|
||||
* Bat pins
|
||||
*/
|
||||
#define PIN_VBAT_READ (5)
|
||||
#define ADC_MULTIPLIER (3 * 1.75 * 1.187 * 1000)
|
||||
|
||||
|
||||
|
||||
/*
|
||||
* Analog pins
|
||||
*/
|
||||
#define PIN_A0 (5) //(3)
|
||||
#define PIN_A1 (31) //(4)
|
||||
#define PIN_A2 (28)
|
||||
#define PIN_A3 (29)
|
||||
#define PIN_A4 (30)
|
||||
#define PIN_A5 (31)
|
||||
#define PIN_A6 (0xff)
|
||||
#define PIN_A7 (0xff)
|
||||
|
||||
static const uint8_t A0 = PIN_A0;
|
||||
static const uint8_t A1 = PIN_A1;
|
||||
static const uint8_t A2 = PIN_A2;
|
||||
static const uint8_t A3 = PIN_A3;
|
||||
static const uint8_t A4 = PIN_A4;
|
||||
static const uint8_t A5 = PIN_A5;
|
||||
static const uint8_t A6 = PIN_A6;
|
||||
static const uint8_t A7 = PIN_A7;
|
||||
#define ADC_RESOLUTION 14
|
||||
|
||||
// Power management boot protection threshold (millivolts)
|
||||
// Set to 0 to disable boot protection
|
||||
#define PWRMGT_VOLTAGE_BOOTLOCK 3300 // Won't boot below this voltage (mV)
|
||||
// LPCOMP wake configuration (voltage recovery from SYSTEMOFF)
|
||||
// AIN3 = P0.05 = PIN_A0 / PIN_VBAT_READ
|
||||
#define PWRMGT_LPCOMP_AIN 3
|
||||
#define PWRMGT_LPCOMP_REFSEL 4 // 5/8 VDD (~3.13-3.44V)
|
||||
|
||||
// Other pins
|
||||
#define PIN_AREF (2)
|
||||
#define PIN_NFC1 (9)
|
||||
#define PIN_NFC2 (10)
|
||||
|
||||
static const uint8_t AREF = PIN_AREF;
|
||||
|
||||
/*
|
||||
* Serial interfaces
|
||||
*/
|
||||
// TXD1 RXD1 on Base Board
|
||||
#define PIN_SERIAL1_RX (15)
|
||||
#define PIN_SERIAL1_TX (16)
|
||||
|
||||
// TXD0 RXD0 on Base Board
|
||||
#define PIN_SERIAL2_RX (19)
|
||||
#define PIN_SERIAL2_TX (20)
|
||||
|
||||
/*
|
||||
* SPI Interfaces
|
||||
*/
|
||||
#define SPI_INTERFACES_COUNT 1
|
||||
|
||||
#define PIN_SPI_MISO (29)
|
||||
#define PIN_SPI_MOSI (30)
|
||||
#define PIN_SPI_SCK (3)
|
||||
|
||||
static const uint8_t SS = 26;
|
||||
static const uint8_t MOSI = PIN_SPI_MOSI;
|
||||
static const uint8_t MISO = PIN_SPI_MISO;
|
||||
static const uint8_t SCK = PIN_SPI_SCK;
|
||||
|
||||
// LoRa radio module pins for RAK4631
|
||||
|
||||
#define SX126X_POWER_EN (37)
|
||||
#define P_LORA_RESET (38)
|
||||
#define P_LORA_NSS (42)
|
||||
#define P_LORA_SCLK (43)
|
||||
#define P_LORA_MOSI (44)
|
||||
#define P_LORA_MISO (45)
|
||||
#define P_LORA_BUSY (46)
|
||||
#define P_LORA_DIO_1 (47)
|
||||
|
||||
#define SX126X_DIO2_AS_RF_SWITCH true
|
||||
#define SX126X_DIO3_TCXO_VOLTAGE 1.8
|
||||
|
||||
/*
|
||||
* Wire Interfaces
|
||||
*/
|
||||
#define WIRE_INTERFACES_COUNT 2
|
||||
|
||||
#define PIN_WIRE_SDA (13)
|
||||
#define PIN_WIRE_SCL (14)
|
||||
|
||||
#define PIN_WIRE1_SDA (24)
|
||||
#define PIN_WIRE1_SCL (25)
|
||||
|
||||
// QSPI Pins
|
||||
// QSPI occupied by GPIO's
|
||||
#define PIN_QSPI_SCK 3 // 19
|
||||
#define PIN_QSPI_CS 26 // 17
|
||||
#define PIN_QSPI_IO0 30 // 20
|
||||
#define PIN_QSPI_IO1 29 // 21
|
||||
#define PIN_QSPI_IO2 28 // 22
|
||||
#define PIN_QSPI_IO3 2 // 23
|
||||
|
||||
// On-board QSPI Flash
|
||||
// No onboard flash
|
||||
#define EXTERNAL_FLASH_DEVICES IS25LP080D
|
||||
#define EXTERNAL_FLASH_USE_QSPI
|
||||
|
||||
#define GPS_ADDRESS 0x42 //i2c address for GPS
|
||||
|
||||
|
||||
// GPS L76KB
|
||||
#define GPS_BAUD_RATE 9600
|
||||
#define GPS_THREAD_INTERVAL 50
|
||||
#define PIN_GPS_TX PIN_SERIAL1_RX
|
||||
#define PIN_GPS_RX PIN_SERIAL1_TX
|
||||
#define PIN_GPS_EN (33)
|
||||
#define PIN_GPS_PPS (17)
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
|
||||
/*----------------------------------------------------------------------------
|
||||
* Arduino objects - C++ only
|
||||
*----------------------------------------------------------------------------*/
|
||||
|
||||
#endif
|
||||
|
|
@ -53,5 +53,5 @@ void GAT562MeshTrackerProBoard::begin() {
|
|||
checkBootVoltage(&power_config);
|
||||
#endif
|
||||
digitalWrite(SX126X_POWER_EN, HIGH);
|
||||
delay(10); // give sx1268 some time to power up
|
||||
delay(10); // give sx1262 some time to power up
|
||||
}
|
||||
|
|
@ -6,10 +6,6 @@ build_flags = ${nrf52_base.build_flags}
|
|||
${sensor_base.build_flags}
|
||||
-I variants/gat562_mesh_tracker_pro
|
||||
-D NRF52_POWER_MANAGEMENT
|
||||
-D LORA_FREQ=475
|
||||
-D LORA_BW=125
|
||||
-D LORA_SF=10
|
||||
-D LORA_CR=6
|
||||
-D PIN_BOARD_SCL=14
|
||||
-D PIN_BOARD_SDA=13
|
||||
-D PIN_OLED_RESET=-1
|
||||
|
|
|
|||
|
|
@ -40,7 +40,7 @@ lib_deps =
|
|||
${esp32_base.lib_deps}
|
||||
https://github.com/Quency-D/heltec-eink-modules/archive/563dd41fd850a1bc3039b8723da4f3a20fe1c800.zip
|
||||
|
||||
[env:Heltec_E213_companion_radio_ble_]
|
||||
[env:Heltec_E213_companion_radio_ble]
|
||||
extends = Heltec_E213_base
|
||||
build_flags =
|
||||
${Heltec_E213_base.build_flags}
|
||||
|
|
@ -48,6 +48,7 @@ build_flags =
|
|||
-D MAX_CONTACTS=350
|
||||
-D MAX_GROUP_CHANNELS=40
|
||||
-D DISPLAY_CLASS=E213Display
|
||||
-D AUTO_OFF_MILLIS=0
|
||||
-D BLE_PIN_CODE=123456 ; dynamic, random PIN
|
||||
-D BLE_DEBUG_LOGGING=1
|
||||
-D OFFLINE_QUEUE_SIZE=256
|
||||
|
|
@ -59,8 +60,9 @@ build_src_filter = ${Heltec_E213_base.build_src_filter}
|
|||
lib_deps =
|
||||
${Heltec_E213_base.lib_deps}
|
||||
densaugeo/base64 @ ~1.4.0
|
||||
bakercp/CRC32 @ ^2.0.0
|
||||
|
||||
[env:Heltec_E213_companion_radio_usb_]
|
||||
[env:Heltec_E213_companion_radio_usb]
|
||||
extends = Heltec_E213_base
|
||||
build_flags =
|
||||
${Heltec_E213_base.build_flags}
|
||||
|
|
@ -68,6 +70,7 @@ build_flags =
|
|||
-D MAX_CONTACTS=350
|
||||
-D MAX_GROUP_CHANNELS=40
|
||||
-D DISPLAY_CLASS=E213Display
|
||||
-D AUTO_OFF_MILLIS=0
|
||||
-D OFFLINE_QUEUE_SIZE=256
|
||||
build_src_filter = ${Heltec_E213_base.build_src_filter}
|
||||
+<helpers/ui/E213Display.cpp>
|
||||
|
|
@ -77,8 +80,9 @@ build_src_filter = ${Heltec_E213_base.build_src_filter}
|
|||
lib_deps =
|
||||
${Heltec_E213_base.lib_deps}
|
||||
densaugeo/base64 @ ~1.4.0
|
||||
bakercp/CRC32 @ ^2.0.0
|
||||
|
||||
[env:Heltec_E213_repeater_]
|
||||
[env:Heltec_E213_repeater]
|
||||
extends = Heltec_E213_base
|
||||
build_flags =
|
||||
${Heltec_E213_base.build_flags}
|
||||
|
|
@ -94,8 +98,9 @@ build_src_filter = ${Heltec_E213_base.build_src_filter}
|
|||
lib_deps =
|
||||
${Heltec_E213_base.lib_deps}
|
||||
${esp32_ota.lib_deps}
|
||||
bakercp/CRC32 @ ^2.0.0
|
||||
|
||||
; [env:Heltec_E213_repeater_bridge_rs232_]
|
||||
; [env:Heltec_E213_repeater_bridge_rs232]
|
||||
; extends = Heltec_E213_base
|
||||
; build_flags =
|
||||
; ${Heltec_E213_base.build_flags}
|
||||
|
|
@ -118,8 +123,9 @@ lib_deps =
|
|||
; lib_deps =
|
||||
; ${Heltec_E213_base.lib_deps}
|
||||
; ${esp32_ota.lib_deps}
|
||||
; bakercp/CRC32 @ ^2.0.0
|
||||
|
||||
[env:Heltec_E213_repeater_bridge_espnow_]
|
||||
[env:Heltec_E213_repeater_bridge_espnow]
|
||||
extends = Heltec_E213_base
|
||||
build_flags =
|
||||
${Heltec_E213_base.build_flags}
|
||||
|
|
@ -140,8 +146,9 @@ build_src_filter = ${Heltec_E213_base.build_src_filter}
|
|||
lib_deps =
|
||||
${Heltec_E213_base.lib_deps}
|
||||
${esp32_ota.lib_deps}
|
||||
bakercp/CRC32 @ ^2.0.0
|
||||
|
||||
[env:Heltec_E213_room_server_]
|
||||
[env:Heltec_E213_room_server]
|
||||
extends = Heltec_E213_base
|
||||
build_flags =
|
||||
${Heltec_E213_base.build_flags}
|
||||
|
|
@ -157,3 +164,4 @@ build_src_filter = ${Heltec_E213_base.build_src_filter}
|
|||
lib_deps =
|
||||
${Heltec_E213_base.lib_deps}
|
||||
${esp32_ota.lib_deps}
|
||||
bakercp/CRC32 @ ^2.0.0
|
||||
|
|
|
|||
|
|
@ -18,7 +18,7 @@ AutoDiscoverRTCClock rtc_clock(fallback_clock);
|
|||
SensorManager sensors;
|
||||
|
||||
#ifdef DISPLAY_CLASS
|
||||
DISPLAY_CLASS display;
|
||||
DISPLAY_CLASS display(&board.periph_power);
|
||||
MomentaryButton user_btn(PIN_USER_BTN, 1000, true);
|
||||
#endif
|
||||
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@ class HeltecE290Board : public ESP32Board {
|
|||
public:
|
||||
RefCountedDigitalPin periph_power;
|
||||
|
||||
HeltecE290Board() : periph_power(PIN_VEXT_EN) { }
|
||||
HeltecE290Board() : periph_power(PIN_VEXT_EN, PIN_VEXT_EN_ACTIVE) { }
|
||||
|
||||
void begin();
|
||||
void enterDeepSleep(uint32_t secs, int pin_wake_btn = -1);
|
||||
|
|
|
|||
|
|
@ -34,7 +34,7 @@ lib_deps =
|
|||
${esp32_base.lib_deps}
|
||||
https://github.com/Quency-D/heltec-eink-modules/archive/563dd41fd850a1bc3039b8723da4f3a20fe1c800.zip
|
||||
|
||||
[env:Heltec_E290_companion_ble_]
|
||||
[env:Heltec_E290_companion_ble]
|
||||
extends = Heltec_E290_base
|
||||
build_flags =
|
||||
${Heltec_E290_base.build_flags}
|
||||
|
|
@ -42,6 +42,7 @@ build_flags =
|
|||
-D MAX_CONTACTS=350
|
||||
-D MAX_GROUP_CHANNELS=40
|
||||
-D DISPLAY_CLASS=E290Display
|
||||
-D AUTO_OFF_MILLIS=0
|
||||
-D BLE_PIN_CODE=123456 ; dynamic, random PIN
|
||||
-D BLE_DEBUG_LOGGING=1
|
||||
-D OFFLINE_QUEUE_SIZE=256
|
||||
|
|
@ -53,8 +54,9 @@ build_src_filter = ${Heltec_E290_base.build_src_filter}
|
|||
lib_deps =
|
||||
${Heltec_E290_base.lib_deps}
|
||||
densaugeo/base64 @ ~1.4.0
|
||||
bakercp/CRC32 @ ^2.0.0
|
||||
|
||||
[env:Heltec_E290_companion_usb_]
|
||||
[env:Heltec_E290_companion_usb]
|
||||
extends = Heltec_E290_base
|
||||
build_flags =
|
||||
${Heltec_E290_base.build_flags}
|
||||
|
|
@ -62,6 +64,7 @@ build_flags =
|
|||
-D MAX_CONTACTS=350
|
||||
-D MAX_GROUP_CHANNELS=40
|
||||
-D DISPLAY_CLASS=E290Display
|
||||
-D AUTO_OFF_MILLIS=0
|
||||
-D BLE_PIN_CODE=123456 ; dynamic, random PIN
|
||||
-D BLE_DEBUG_LOGGING=1
|
||||
-D OFFLINE_QUEUE_SIZE=256
|
||||
|
|
@ -73,8 +76,9 @@ build_src_filter = ${Heltec_E290_base.build_src_filter}
|
|||
lib_deps =
|
||||
${Heltec_E290_base.lib_deps}
|
||||
densaugeo/base64 @ ~1.4.0
|
||||
bakercp/CRC32 @ ^2.0.0
|
||||
|
||||
[env:Heltec_E290_repeater_]
|
||||
[env:Heltec_E290_repeater]
|
||||
extends = Heltec_E290_base
|
||||
build_flags =
|
||||
${Heltec_E290_base.build_flags}
|
||||
|
|
@ -90,8 +94,9 @@ build_src_filter = ${Heltec_E290_base.build_src_filter}
|
|||
lib_deps =
|
||||
${Heltec_E290_base.lib_deps}
|
||||
${esp32_ota.lib_deps}
|
||||
bakercp/CRC32 @ ^2.0.0
|
||||
|
||||
; [env:Heltec_E290_repeater_bridge_rs232_]
|
||||
; [env:Heltec_E290_repeater_bridge_rs232]
|
||||
; extends = Heltec_E290_base
|
||||
; build_flags =
|
||||
; ${Heltec_E290_base.build_flags}
|
||||
|
|
@ -114,8 +119,9 @@ lib_deps =
|
|||
; lib_deps =
|
||||
; ${Heltec_E290_base.lib_deps}
|
||||
; ${esp32_ota.lib_deps}
|
||||
; bakercp/CRC32 @ ^2.0.0
|
||||
|
||||
[env:Heltec_E290_repeater_bridge_espnow_]
|
||||
[env:Heltec_E290_repeater_bridge_espnow]
|
||||
extends = Heltec_E290_base
|
||||
build_flags =
|
||||
${Heltec_E290_base.build_flags}
|
||||
|
|
@ -136,8 +142,9 @@ build_src_filter = ${Heltec_E290_base.build_src_filter}
|
|||
lib_deps =
|
||||
${Heltec_E290_base.lib_deps}
|
||||
${esp32_ota.lib_deps}
|
||||
bakercp/CRC32 @ ^2.0.0
|
||||
|
||||
[env:Heltec_E290_room_server_]
|
||||
[env:Heltec_E290_room_server]
|
||||
extends = Heltec_E290_base
|
||||
build_flags =
|
||||
${Heltec_E290_base.build_flags}
|
||||
|
|
@ -153,3 +160,4 @@ build_src_filter = ${Heltec_E290_base.build_src_filter}
|
|||
lib_deps =
|
||||
${Heltec_E290_base.lib_deps}
|
||||
${esp32_ota.lib_deps}
|
||||
bakercp/CRC32 @ ^2.0.0
|
||||
|
|
|
|||
|
|
@ -18,7 +18,7 @@ AutoDiscoverRTCClock rtc_clock(fallback_clock);
|
|||
SensorManager sensors;
|
||||
|
||||
#ifdef DISPLAY_CLASS
|
||||
DISPLAY_CLASS display;
|
||||
DISPLAY_CLASS display(&board.periph_power);
|
||||
MomentaryButton user_btn(PIN_USER_BTN, 1000, true);
|
||||
#endif
|
||||
|
||||
|
|
|
|||
|
|
@ -60,6 +60,7 @@ build_src_filter = ${Heltec_Wireless_Paper_base.build_src_filter}
|
|||
lib_deps =
|
||||
${Heltec_Wireless_Paper_base.lib_deps}
|
||||
densaugeo/base64 @ ~1.4.0
|
||||
bakercp/CRC32 @ ^2.0.0
|
||||
|
||||
[env:Heltec_Wireless_Paper_repeater]
|
||||
extends = Heltec_Wireless_Paper_base
|
||||
|
|
@ -77,6 +78,7 @@ build_src_filter = ${Heltec_Wireless_Paper_base.build_src_filter}
|
|||
lib_deps =
|
||||
${Heltec_Wireless_Paper_base.lib_deps}
|
||||
${esp32_ota.lib_deps}
|
||||
bakercp/CRC32 @ ^2.0.0
|
||||
|
||||
; [env:Heltec_Wireless_Paper_repeater_bridge_rs232]
|
||||
; extends = Heltec_Wireless_Paper_base
|
||||
|
|
@ -123,6 +125,7 @@ build_src_filter = ${Heltec_Wireless_Paper_base.build_src_filter}
|
|||
lib_deps =
|
||||
${Heltec_Wireless_Paper_base.lib_deps}
|
||||
${esp32_ota.lib_deps}
|
||||
bakercp/CRC32 @ ^2.0.0
|
||||
|
||||
[env:Heltec_Wireless_Paper_room_server]
|
||||
extends = Heltec_Wireless_Paper_base
|
||||
|
|
@ -140,3 +143,4 @@ build_src_filter = ${Heltec_Wireless_Paper_base.build_src_filter}
|
|||
lib_deps =
|
||||
${Heltec_Wireless_Paper_base.lib_deps}
|
||||
${esp32_ota.lib_deps}
|
||||
bakercp/CRC32 @ ^2.0.0
|
||||
|
|
|
|||
|
|
@ -3,6 +3,31 @@
|
|||
|
||||
#include "RAK3401Board.h"
|
||||
|
||||
#ifdef NRF52_POWER_MANAGEMENT
|
||||
// Static configuration for power management
|
||||
// Values set in variant.h defines
|
||||
const PowerMgtConfig power_config = {
|
||||
.lpcomp_ain_channel = PWRMGT_LPCOMP_AIN,
|
||||
.lpcomp_refsel = PWRMGT_LPCOMP_REFSEL,
|
||||
.voltage_bootlock = PWRMGT_VOLTAGE_BOOTLOCK
|
||||
};
|
||||
|
||||
void RAK3401Board::initiateShutdown(uint8_t reason) {
|
||||
// Disable SKY66122 FEM (CSD+CPS LOW = shutdown, <1 uA)
|
||||
digitalWrite(SX126X_POWER_EN, LOW);
|
||||
|
||||
// Disable 3V3 switched peripherals and 5V boost
|
||||
digitalWrite(PIN_3V3_EN, LOW);
|
||||
|
||||
if (reason == SHUTDOWN_REASON_LOW_VOLTAGE ||
|
||||
reason == SHUTDOWN_REASON_BOOT_PROTECT) {
|
||||
configureVoltageWake(power_config.lpcomp_ain_channel, power_config.lpcomp_refsel);
|
||||
}
|
||||
|
||||
enterSystemOff(reason);
|
||||
}
|
||||
#endif
|
||||
|
||||
void RAK3401Board::begin() {
|
||||
NRF52BoardDCDC::begin();
|
||||
pinMode(PIN_VBAT_READ, INPUT);
|
||||
|
|
@ -31,18 +56,11 @@ void RAK3401Board::begin() {
|
|||
// HIGH = FEM active (LNA for RX, PA path available for TX).
|
||||
// TX/RX switching (CTX) is handled by SX1262 DIO2 via SetDIO2AsRfSwitchCtrl.
|
||||
pinMode(SX126X_POWER_EN, OUTPUT);
|
||||
#ifdef NRF52_POWER_MANAGEMENT
|
||||
// Boot voltage protection check (may not return if voltage too low)
|
||||
// We need to call this after we configure SX126X_POWER_EN as output but before we pull high
|
||||
checkBootVoltage(&power_config);
|
||||
#endif
|
||||
digitalWrite(SX126X_POWER_EN, HIGH);
|
||||
delay(1); // SKY66122 turn-on settling time (tON = 3us typ)
|
||||
}
|
||||
|
||||
#ifdef NRF52_POWER_MANAGEMENT
|
||||
void RAK3401Board::initiateShutdown(uint8_t reason) {
|
||||
// Disable SKY66122 FEM (CSD+CPS LOW = shutdown, <1 uA)
|
||||
digitalWrite(SX126X_POWER_EN, LOW);
|
||||
|
||||
// Disable 3V3 switched peripherals and 5V boost
|
||||
digitalWrite(PIN_3V3_EN, LOW);
|
||||
|
||||
enterSystemOff(reason);
|
||||
}
|
||||
#endif
|
||||
|
|
|
|||
|
|
@ -6,6 +6,7 @@ build_flags = ${nrf52_base.build_flags}
|
|||
${sensor_base.build_flags}
|
||||
-I variants/rak3401
|
||||
-D RAK_3401
|
||||
-D NRF52_POWER_MANAGEMENT
|
||||
-D RADIO_CLASS=CustomSX1262
|
||||
-D WRAPPER_CLASS=CustomSX1262Wrapper
|
||||
-D LORA_TX_POWER=22
|
||||
|
|
@ -124,4 +125,4 @@ build_flags =
|
|||
;-D MESH_DEBUG=1
|
||||
build_src_filter = ${rak3401.build_src_filter}
|
||||
+<helpers/ui/SSD1306Display.cpp>
|
||||
+<../examples/simple_sensor>
|
||||
+<../examples/simple_sensor>
|
||||
|
|
|
|||
|
|
@ -78,6 +78,14 @@ extern "C"
|
|||
static const uint8_t A7 = PIN_A7;
|
||||
#define ADC_RESOLUTION 14
|
||||
|
||||
// Power management boot protection threshold (millivolts)
|
||||
// Set to 0 to disable boot protection
|
||||
#define PWRMGT_VOLTAGE_BOOTLOCK 3300 // Won't boot below this voltage (mV)
|
||||
// LPCOMP wake configuration (voltage recovery from SYSTEMOFF)
|
||||
// AIN3 = P0.05 = PIN_A0 / PIN_VBAT_READ
|
||||
#define PWRMGT_LPCOMP_AIN 3
|
||||
#define PWRMGT_LPCOMP_REFSEL 4 // 5/8 VDD (~3.13-3.44V)
|
||||
|
||||
// Other pins
|
||||
#define WB_I2C1_SDA (13) // SENSOR_SLOT IO_SLOT
|
||||
#define WB_I2C1_SCL (14) // SENSOR_SLOT IO_SLOT
|
||||
|
|
|
|||
|
|
@ -3,8 +3,43 @@
|
|||
|
||||
#include "SenseCapSolarBoard.h"
|
||||
|
||||
#ifdef NRF52_POWER_MANAGEMENT
|
||||
const PowerMgtConfig power_config = {
|
||||
.lpcomp_ain_channel = PWRMGT_LPCOMP_AIN,
|
||||
.lpcomp_refsel = PWRMGT_LPCOMP_REFSEL,
|
||||
.voltage_bootlock = PWRMGT_VOLTAGE_BOOTLOCK
|
||||
};
|
||||
|
||||
void SenseCapSolarBoard::initiateShutdown(uint8_t reason) {
|
||||
bool enable_lpcomp = (reason == SHUTDOWN_REASON_LOW_VOLTAGE ||
|
||||
reason == SHUTDOWN_REASON_BOOT_PROTECT);
|
||||
|
||||
pinMode(VBAT_ENABLE, OUTPUT);
|
||||
digitalWrite(VBAT_ENABLE, enable_lpcomp ? LOW : HIGH);
|
||||
|
||||
if (enable_lpcomp) {
|
||||
configureVoltageWake(power_config.lpcomp_ain_channel, power_config.lpcomp_refsel);
|
||||
}
|
||||
|
||||
enterSystemOff(reason);
|
||||
}
|
||||
#endif // NRF52_POWER_MANAGEMENT
|
||||
|
||||
void SenseCapSolarBoard::begin() {
|
||||
NRF52Board::begin();
|
||||
NRF52BoardDCDC::begin();
|
||||
|
||||
pinMode(BATTERY_PIN, INPUT);
|
||||
pinMode(VBAT_ENABLE, OUTPUT);
|
||||
digitalWrite(VBAT_ENABLE, LOW);
|
||||
analogReadResolution(12);
|
||||
analogReference(AR_INTERNAL_3_0);
|
||||
delay(50);
|
||||
|
||||
#ifdef PIN_USER_BTN
|
||||
pinMode(PIN_USER_BTN, INPUT_PULLUP);
|
||||
#elif defined(PIN_BUTTON1)
|
||||
pinMode(PIN_BUTTON1, INPUT_PULLUP);
|
||||
#endif
|
||||
|
||||
#if defined(PIN_WIRE_SDA) && defined(PIN_WIRE_SCL)
|
||||
Wire.setPins(PIN_WIRE_SDA, PIN_WIRE_SCL);
|
||||
|
|
@ -12,10 +47,23 @@ void SenseCapSolarBoard::begin() {
|
|||
|
||||
Wire.begin();
|
||||
|
||||
#ifdef LED_WHITE
|
||||
pinMode(LED_WHITE, OUTPUT);
|
||||
digitalWrite(LED_WHITE, HIGH);
|
||||
#endif
|
||||
#ifdef LED_BLUE
|
||||
pinMode(LED_BLUE, OUTPUT);
|
||||
digitalWrite(LED_BLUE, LOW);
|
||||
#endif
|
||||
|
||||
#ifdef P_LORA_TX_LED
|
||||
pinMode(P_LORA_TX_LED, OUTPUT);
|
||||
digitalWrite(P_LORA_TX_LED, LOW);
|
||||
#endif
|
||||
|
||||
#ifdef NRF52_POWER_MANAGEMENT
|
||||
checkBootVoltage(&power_config);
|
||||
#endif
|
||||
|
||||
delay(10); // give sx1262 some time to power up
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -5,6 +5,11 @@
|
|||
#include <helpers/NRF52Board.h>
|
||||
|
||||
class SenseCapSolarBoard : public NRF52BoardDCDC {
|
||||
protected:
|
||||
#ifdef NRF52_POWER_MANAGEMENT
|
||||
void initiateShutdown(uint8_t reason) override;
|
||||
#endif
|
||||
|
||||
public:
|
||||
SenseCapSolarBoard() : NRF52Board("SENSECAP_SOLAR_OTA") {}
|
||||
void begin();
|
||||
|
|
@ -31,4 +36,25 @@ public:
|
|||
const char* getManufacturerName() const override {
|
||||
return "Seeed SenseCap Solar";
|
||||
}
|
||||
|
||||
void powerOff() override {
|
||||
digitalWrite(LED_WHITE, LOW);
|
||||
digitalWrite(LED_BLUE, LOW);
|
||||
|
||||
#ifdef PIN_USER_BTN
|
||||
while (digitalRead(PIN_USER_BTN) == LOW);
|
||||
// Keep pull-up enabled in system-off so the wake line doesn't float low.
|
||||
nrf_gpio_cfg_sense_input(digitalPinToInterrupt(g_ADigitalPinMap[PIN_USER_BTN]), NRF_GPIO_PIN_PULLUP, NRF_GPIO_PIN_SENSE_LOW);
|
||||
#elif defined(PIN_BUTTON1)
|
||||
while (digitalRead(PIN_BUTTON1) == LOW);
|
||||
// Keep pull-up enabled in system-off so the wake line doesn't float low.
|
||||
nrf_gpio_cfg_sense_input(digitalPinToInterrupt(g_ADigitalPinMap[PIN_BUTTON1]), NRF_GPIO_PIN_PULLUP, NRF_GPIO_PIN_SENSE_LOW);
|
||||
#endif
|
||||
|
||||
#ifdef NRF52_POWER_MANAGEMENT
|
||||
initiateShutdown(SHUTDOWN_REASON_USER);
|
||||
#else
|
||||
sd_power_system_off();
|
||||
#endif
|
||||
}
|
||||
};
|
||||
|
|
|
|||
|
|
@ -9,13 +9,15 @@ build_flags = ${nrf52_base.build_flags}
|
|||
-I variants/sensecap_solar
|
||||
-I src/helpers/nrf52
|
||||
-D NRF52_PLATFORM=1
|
||||
-D NRF52_POWER_MANAGEMENT
|
||||
-D RADIO_CLASS=CustomSX1262
|
||||
-D WRAPPER_CLASS=CustomSX1262Wrapper
|
||||
-D P_LORA_TX_LED=12
|
||||
-D P_LORA_TX_LED=11
|
||||
-D P_LORA_DIO_1=1
|
||||
-D P_LORA_RESET=2
|
||||
-D P_LORA_BUSY=3
|
||||
-D P_LORA_NSS=4
|
||||
-D PIN_USER_BTN=PIN_BUTTON1
|
||||
-D LORA_TX_POWER=22
|
||||
-D SX126X_RXEN=5
|
||||
-D SX126X_TXEN=RADIOLIB_NC
|
||||
|
|
@ -96,4 +98,4 @@ build_src_filter = ${SenseCap_Solar.build_src_filter}
|
|||
+<../examples/companion_radio/*.cpp>
|
||||
lib_deps =
|
||||
${SenseCap_Solar.lib_deps}
|
||||
densaugeo/base64 @ ~1.4.0
|
||||
densaugeo/base64 @ ~1.4.0
|
||||
|
|
|
|||
|
|
@ -32,6 +32,7 @@
|
|||
// Buttons
|
||||
#define PIN_BUTTON1 (13)
|
||||
#define PIN_BUTTON2 (20)
|
||||
#define PIN_USER_BTN PIN_BUTTON1
|
||||
|
||||
#define VBAT_ENABLE (19) // Output LOW to enable reading of the BAT voltage.
|
||||
|
||||
|
|
@ -41,6 +42,11 @@
|
|||
#define ADC_MULTIPLIER (3.0F) // 1M, 512k divider bridge
|
||||
#define ADC_RESOLUTION (12)
|
||||
|
||||
// nRF52 power management settings
|
||||
#define PWRMGT_VOLTAGE_BOOTLOCK (3300) // Won't boot below this voltage (mV)
|
||||
#define PWRMGT_LPCOMP_AIN (7) // AIN7 = P0.31 = BATTERY_PIN
|
||||
#define PWRMGT_LPCOMP_REFSEL (2) // 3/8 VDD (~3.38-3.71V)
|
||||
|
||||
// Serial interfaces
|
||||
#define PIN_SERIAL1_RX (7)
|
||||
#define PIN_SERIAL1_TX (6)
|
||||
|
|
@ -82,4 +88,4 @@
|
|||
#define EXTERNAL_FLASH_DEVICES P25Q16H
|
||||
#define EXTERNAL_FLASH_USE_QSPI
|
||||
|
||||
#endif
|
||||
#endif
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue