mirror of https://github.com/meshcore-dev/MeshCore
Florent de Lamotte
9 months ago
80 changed files with 3213 additions and 416 deletions
@ -0,0 +1,34 @@ |
|||
#pragma once |
|||
|
|||
#include <Mesh.h> |
|||
|
|||
class AbstractBridge { |
|||
public: |
|||
virtual ~AbstractBridge() {} |
|||
|
|||
/**
|
|||
* @brief Initializes the bridge. |
|||
*/ |
|||
virtual void begin() = 0; |
|||
|
|||
/**
|
|||
* @brief A method to be called on every main loop iteration. |
|||
* Used for tasks like checking for incoming data. |
|||
*/ |
|||
virtual void loop() = 0; |
|||
|
|||
/**
|
|||
* @brief A callback that is triggered when the mesh transmits a packet. |
|||
* The bridge can use this to forward the packet. |
|||
* |
|||
* @param packet The packet that was transmitted. |
|||
*/ |
|||
virtual void onPacketTransmitted(mesh::Packet* packet) = 0; |
|||
|
|||
/**
|
|||
* @brief Processes a received packet from the bridge's medium. |
|||
* |
|||
* @param packet The packet that was received. |
|||
*/ |
|||
virtual void onPacketReceived(mesh::Packet* packet) = 0; |
|||
}; |
|||
@ -0,0 +1,36 @@ |
|||
#include "BridgeBase.h" |
|||
|
|||
#include <Arduino.h> |
|||
|
|||
const char *BridgeBase::getLogDateTime() { |
|||
static char tmp[32]; |
|||
uint32_t now = _rtc->getCurrentTime(); |
|||
DateTime dt = DateTime(now); |
|||
sprintf(tmp, "%02d:%02d:%02d - %d/%d/%d U", dt.hour(), dt.minute(), dt.second(), dt.day(), dt.month(), |
|||
dt.year()); |
|||
return tmp; |
|||
} |
|||
|
|||
uint16_t BridgeBase::fletcher16(const uint8_t *data, size_t len) { |
|||
uint8_t sum1 = 0, sum2 = 0; |
|||
|
|||
for (size_t i = 0; i < len; i++) { |
|||
sum1 = (sum1 + data[i]) % 255; |
|||
sum2 = (sum2 + sum1) % 255; |
|||
} |
|||
|
|||
return (sum2 << 8) | sum1; |
|||
} |
|||
|
|||
bool BridgeBase::validateChecksum(const uint8_t *data, size_t len, uint16_t received_checksum) { |
|||
uint16_t calculated_checksum = fletcher16(data, len); |
|||
return received_checksum == calculated_checksum; |
|||
} |
|||
|
|||
void BridgeBase::handleReceivedPacket(mesh::Packet *packet) { |
|||
if (!_seen_packets.hasSeen(packet)) { |
|||
_mgr->queueInbound(packet, millis() + BRIDGE_DELAY); |
|||
} else { |
|||
_mgr->free(packet); |
|||
} |
|||
} |
|||
@ -0,0 +1,112 @@ |
|||
#pragma once |
|||
|
|||
#include "helpers/AbstractBridge.h" |
|||
#include "helpers/SimpleMeshTables.h" |
|||
|
|||
#include <RTClib.h> |
|||
|
|||
/**
|
|||
* @brief Base class implementing common bridge functionality |
|||
* |
|||
* This class provides common functionality used by different bridge implementations |
|||
* like packet tracking, checksum calculation, timestamping, and duplicate detection. |
|||
* |
|||
* Features: |
|||
* - Fletcher-16 checksum calculation for data integrity |
|||
* - Packet duplicate detection using SimpleMeshTables |
|||
* - Common timestamp formatting for debug logging |
|||
* - Shared packet management and queuing logic |
|||
*/ |
|||
class BridgeBase : public AbstractBridge { |
|||
public: |
|||
virtual ~BridgeBase() = default; |
|||
|
|||
/**
|
|||
* @brief Common magic number used by all bridge implementations for packet identification |
|||
* |
|||
* This magic number is placed at the beginning of bridge packets to identify |
|||
* them as mesh bridge packets and provide frame synchronization. |
|||
*/ |
|||
static constexpr uint16_t BRIDGE_PACKET_MAGIC = 0xC03E; |
|||
|
|||
/**
|
|||
* @brief Common field sizes used by bridge implementations |
|||
* |
|||
* These constants define the size of common packet fields used across bridges. |
|||
* BRIDGE_MAGIC_SIZE is used by all bridges for packet identification. |
|||
* BRIDGE_LENGTH_SIZE is used by bridges that need explicit length fields (like RS232). |
|||
* BRIDGE_CHECKSUM_SIZE is used by all bridges for Fletcher-16 checksums. |
|||
*/ |
|||
static constexpr uint16_t BRIDGE_MAGIC_SIZE = sizeof(BRIDGE_PACKET_MAGIC); |
|||
static constexpr uint16_t BRIDGE_LENGTH_SIZE = sizeof(uint16_t); |
|||
static constexpr uint16_t BRIDGE_CHECKSUM_SIZE = sizeof(uint16_t); |
|||
|
|||
/**
|
|||
* @brief Default delay in milliseconds for scheduling inbound packet processing |
|||
* |
|||
* It provides a buffer to prevent immediate processing conflicts in the mesh network. |
|||
* Used in handleReceivedPacket() as: millis() + BRIDGE_DELAY |
|||
*/ |
|||
static constexpr uint16_t BRIDGE_DELAY = 500; // TODO: maybe too high ?
|
|||
|
|||
protected: |
|||
/** Packet manager for allocating and queuing mesh packets */ |
|||
mesh::PacketManager *_mgr; |
|||
|
|||
/** RTC clock for timestamping debug messages */ |
|||
mesh::RTCClock *_rtc; |
|||
|
|||
/** Tracks seen packets to prevent loops in broadcast communications */ |
|||
SimpleMeshTables _seen_packets; |
|||
|
|||
/**
|
|||
* @brief Constructs a BridgeBase instance |
|||
* |
|||
* @param mgr PacketManager for allocating and queuing packets |
|||
* @param rtc RTCClock for timestamping debug messages |
|||
*/ |
|||
BridgeBase(mesh::PacketManager *mgr, mesh::RTCClock *rtc) : _mgr(mgr), _rtc(rtc) {} |
|||
|
|||
/**
|
|||
* @brief Gets formatted date/time string for logging |
|||
* |
|||
* Format: "HH:MM:SS - DD/MM/YYYY U" |
|||
* |
|||
* @return Formatted date/time string |
|||
*/ |
|||
const char *getLogDateTime(); |
|||
|
|||
/**
|
|||
* @brief Calculate Fletcher-16 checksum |
|||
* |
|||
* Based on: https://en.wikipedia.org/wiki/Fletcher%27s_checksum
|
|||
* Used to verify data integrity of received packets |
|||
* |
|||
* @param data Pointer to data to calculate checksum for |
|||
* @param len Length of data in bytes |
|||
* @return Calculated Fletcher-16 checksum |
|||
*/ |
|||
static uint16_t fletcher16(const uint8_t *data, size_t len); |
|||
|
|||
/**
|
|||
* @brief Validate received checksum against calculated checksum |
|||
* |
|||
* @param data Pointer to data to validate |
|||
* @param len Length of data in bytes |
|||
* @param received_checksum Checksum received with data |
|||
* @return true if checksum is valid, false otherwise |
|||
*/ |
|||
bool validateChecksum(const uint8_t *data, size_t len, uint16_t received_checksum); |
|||
|
|||
/**
|
|||
* @brief Common packet handling for received packets |
|||
* |
|||
* Implements the standard pattern used by all bridges: |
|||
* - Check if packet was seen before using _seen_packets.hasSeen() |
|||
* - Queue packet for mesh processing if not seen before |
|||
* - Free packet if already seen to prevent duplicates |
|||
* |
|||
* @param packet The received mesh packet |
|||
*/ |
|||
void handleReceivedPacket(mesh::Packet *packet); |
|||
}; |
|||
@ -0,0 +1,196 @@ |
|||
#include "ESPNowBridge.h" |
|||
|
|||
#include <WiFi.h> |
|||
#include <esp_wifi.h> |
|||
|
|||
#ifdef WITH_ESPNOW_BRIDGE |
|||
|
|||
// Static member to handle callbacks
|
|||
ESPNowBridge *ESPNowBridge::_instance = nullptr; |
|||
|
|||
// Static callback wrappers
|
|||
void ESPNowBridge::recv_cb(const uint8_t *mac, const uint8_t *data, int32_t len) { |
|||
if (_instance) { |
|||
_instance->onDataRecv(mac, data, len); |
|||
} |
|||
} |
|||
|
|||
void ESPNowBridge::send_cb(const uint8_t *mac, esp_now_send_status_t status) { |
|||
if (_instance) { |
|||
_instance->onDataSent(mac, status); |
|||
} |
|||
} |
|||
|
|||
ESPNowBridge::ESPNowBridge(mesh::PacketManager *mgr, mesh::RTCClock *rtc) |
|||
: BridgeBase(mgr, rtc), _rx_buffer_pos(0) { |
|||
_instance = this; |
|||
} |
|||
|
|||
void ESPNowBridge::begin() { |
|||
// Initialize WiFi in station mode
|
|||
WiFi.mode(WIFI_STA); |
|||
|
|||
// Initialize ESP-NOW
|
|||
if (esp_now_init() != ESP_OK) { |
|||
Serial.printf("%s: ESPNOW BRIDGE: Error initializing ESP-NOW\n", getLogDateTime()); |
|||
return; |
|||
} |
|||
|
|||
// Register callbacks
|
|||
esp_now_register_recv_cb(recv_cb); |
|||
esp_now_register_send_cb(send_cb); |
|||
|
|||
// Add broadcast peer
|
|||
esp_now_peer_info_t peerInfo = {}; |
|||
memset(&peerInfo, 0, sizeof(peerInfo)); |
|||
memset(peerInfo.peer_addr, 0xFF, ESP_NOW_ETH_ALEN); // Broadcast address
|
|||
peerInfo.channel = 0; |
|||
peerInfo.encrypt = false; |
|||
|
|||
if (esp_now_add_peer(&peerInfo) != ESP_OK) { |
|||
Serial.printf("%s: ESPNOW BRIDGE: Failed to add broadcast peer\n", getLogDateTime()); |
|||
return; |
|||
} |
|||
} |
|||
|
|||
void ESPNowBridge::loop() { |
|||
// Nothing to do here - ESP-NOW is callback based
|
|||
} |
|||
|
|||
void ESPNowBridge::xorCrypt(uint8_t *data, size_t len) { |
|||
size_t keyLen = strlen(_secret); |
|||
for (size_t i = 0; i < len; i++) { |
|||
data[i] ^= _secret[i % keyLen]; |
|||
} |
|||
} |
|||
|
|||
void ESPNowBridge::onDataRecv(const uint8_t *mac, const uint8_t *data, int32_t len) { |
|||
// Ignore packets that are too small to contain header + checksum
|
|||
if (len < (BRIDGE_MAGIC_SIZE + BRIDGE_CHECKSUM_SIZE)) { |
|||
#if MESH_PACKET_LOGGING |
|||
Serial.printf("%s: ESPNOW BRIDGE: RX packet too small, len=%d\n", getLogDateTime(), len); |
|||
#endif |
|||
return; |
|||
} |
|||
|
|||
// Validate total packet size
|
|||
if (len > MAX_ESPNOW_PACKET_SIZE) { |
|||
#if MESH_PACKET_LOGGING |
|||
Serial.printf("%s: ESPNOW BRIDGE: RX packet too large, len=%d\n", getLogDateTime(), len); |
|||
#endif |
|||
return; |
|||
} |
|||
|
|||
// Check packet header magic
|
|||
uint16_t received_magic = (data[0] << 8) | data[1]; |
|||
if (received_magic != BRIDGE_PACKET_MAGIC) { |
|||
#if MESH_PACKET_LOGGING |
|||
Serial.printf("%s: ESPNOW BRIDGE: RX invalid magic 0x%04X\n", getLogDateTime(), received_magic); |
|||
#endif |
|||
return; |
|||
} |
|||
|
|||
// Make a copy we can decrypt
|
|||
uint8_t decrypted[MAX_ESPNOW_PACKET_SIZE]; |
|||
const size_t encryptedDataLen = len - BRIDGE_MAGIC_SIZE; |
|||
memcpy(decrypted, data + BRIDGE_MAGIC_SIZE, encryptedDataLen); |
|||
|
|||
// Try to decrypt (checksum + payload)
|
|||
xorCrypt(decrypted, encryptedDataLen); |
|||
|
|||
// Validate checksum
|
|||
uint16_t received_checksum = (decrypted[0] << 8) | decrypted[1]; |
|||
const size_t payloadLen = encryptedDataLen - BRIDGE_CHECKSUM_SIZE; |
|||
|
|||
if (!validateChecksum(decrypted + BRIDGE_CHECKSUM_SIZE, payloadLen, received_checksum)) { |
|||
// Failed to decrypt - likely from a different network
|
|||
#if MESH_PACKET_LOGGING |
|||
Serial.printf("%s: ESPNOW BRIDGE: RX checksum mismatch, rcv=0x%04X\n", getLogDateTime(), |
|||
received_checksum); |
|||
#endif |
|||
return; |
|||
} |
|||
|
|||
#if MESH_PACKET_LOGGING |
|||
Serial.printf("%s: ESPNOW BRIDGE: RX, payload_len=%d\n", getLogDateTime(), payloadLen); |
|||
#endif |
|||
|
|||
// Create mesh packet
|
|||
mesh::Packet *pkt = _instance->_mgr->allocNew(); |
|||
if (!pkt) return; |
|||
|
|||
if (pkt->readFrom(decrypted + BRIDGE_CHECKSUM_SIZE, payloadLen)) { |
|||
_instance->onPacketReceived(pkt); |
|||
} else { |
|||
_instance->_mgr->free(pkt); |
|||
} |
|||
} |
|||
|
|||
void ESPNowBridge::onDataSent(const uint8_t *mac_addr, esp_now_send_status_t status) { |
|||
// Could add transmission error handling here if needed
|
|||
} |
|||
|
|||
void ESPNowBridge::onPacketReceived(mesh::Packet *packet) { |
|||
handleReceivedPacket(packet); |
|||
} |
|||
|
|||
void ESPNowBridge::onPacketTransmitted(mesh::Packet *packet) { |
|||
// First validate the packet pointer
|
|||
if (!packet) { |
|||
#if MESH_PACKET_LOGGING |
|||
Serial.printf("%s: ESPNOW BRIDGE: TX invalid packet pointer\n", getLogDateTime()); |
|||
#endif |
|||
return; |
|||
} |
|||
|
|||
if (!_seen_packets.hasSeen(packet)) { |
|||
|
|||
// Create a temporary buffer just for size calculation and reuse for actual writing
|
|||
uint8_t sizingBuffer[MAX_PAYLOAD_SIZE]; |
|||
uint16_t meshPacketLen = packet->writeTo(sizingBuffer); |
|||
|
|||
// Check if packet fits within our maximum payload size
|
|||
if (meshPacketLen > MAX_PAYLOAD_SIZE) { |
|||
#if MESH_PACKET_LOGGING |
|||
Serial.printf("%s: ESPNOW BRIDGE: TX packet too large (payload=%d, max=%d)\n", getLogDateTime(), |
|||
meshPacketLen, MAX_PAYLOAD_SIZE); |
|||
#endif |
|||
return; |
|||
} |
|||
|
|||
uint8_t buffer[MAX_ESPNOW_PACKET_SIZE]; |
|||
|
|||
// Write magic header (2 bytes)
|
|||
buffer[0] = (BRIDGE_PACKET_MAGIC >> 8) & 0xFF; |
|||
buffer[1] = BRIDGE_PACKET_MAGIC & 0xFF; |
|||
|
|||
// Write packet payload starting after magic header and checksum
|
|||
const size_t packetOffset = BRIDGE_MAGIC_SIZE + BRIDGE_CHECKSUM_SIZE; |
|||
memcpy(buffer + packetOffset, sizingBuffer, meshPacketLen); |
|||
|
|||
// Calculate and add checksum (only of the payload)
|
|||
uint16_t checksum = fletcher16(buffer + packetOffset, meshPacketLen); |
|||
buffer[2] = (checksum >> 8) & 0xFF; // High byte
|
|||
buffer[3] = checksum & 0xFF; // Low byte
|
|||
|
|||
// Encrypt payload and checksum (not including magic header)
|
|||
xorCrypt(buffer + BRIDGE_MAGIC_SIZE, meshPacketLen + BRIDGE_CHECKSUM_SIZE); |
|||
|
|||
// Total packet size: magic header + checksum + payload
|
|||
const size_t totalPacketSize = BRIDGE_MAGIC_SIZE + BRIDGE_CHECKSUM_SIZE + meshPacketLen; |
|||
|
|||
// Broadcast using ESP-NOW
|
|||
uint8_t broadcastAddress[] = { 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF }; |
|||
esp_err_t result = esp_now_send(broadcastAddress, buffer, totalPacketSize); |
|||
|
|||
#if MESH_PACKET_LOGGING |
|||
if (result == ESP_OK) { |
|||
Serial.printf("%s: ESPNOW BRIDGE: TX, len=%d\n", getLogDateTime(), meshPacketLen); |
|||
} else { |
|||
Serial.printf("%s: ESPNOW BRIDGE: TX FAILED!\n", getLogDateTime()); |
|||
} |
|||
#endif |
|||
} |
|||
} |
|||
|
|||
#endif |
|||
@ -0,0 +1,156 @@ |
|||
#pragma once |
|||
|
|||
#include "MeshCore.h" |
|||
#include "esp_now.h" |
|||
#include "helpers/bridges/BridgeBase.h" |
|||
|
|||
#ifdef WITH_ESPNOW_BRIDGE |
|||
|
|||
#ifndef WITH_ESPNOW_BRIDGE_SECRET |
|||
#error WITH_ESPNOW_BRIDGE_SECRET must be defined to use ESPNowBridge |
|||
#endif |
|||
|
|||
/**
|
|||
* @brief Bridge implementation using ESP-NOW protocol for packet transport |
|||
* |
|||
* This bridge enables mesh packet transport over ESP-NOW, a connectionless communication |
|||
* protocol provided by Espressif that allows ESP32 devices to communicate directly |
|||
* without WiFi router infrastructure. |
|||
* |
|||
* Features: |
|||
* - Broadcast-based communication (all bridges receive all packets) |
|||
* - Network isolation using XOR encryption with shared secret |
|||
* - Duplicate packet detection using SimpleMeshTables tracking |
|||
* - Maximum packet size of 250 bytes (ESP-NOW limitation) |
|||
* |
|||
* Packet Structure: |
|||
* [2 bytes] Magic Header - Used to identify ESPNowBridge packets |
|||
* [2 bytes] Fletcher-16 checksum of encrypted payload (calculated over payload only) |
|||
* [246 bytes max] Encrypted payload containing the mesh packet |
|||
* |
|||
* The Fletcher-16 checksum is used to validate packet integrity and detect |
|||
* corrupted or tampered packets. It's calculated over the encrypted payload |
|||
* and provides a simple but effective way to verify packets are both |
|||
* uncorrupted and from the same network (since the checksum is calculated |
|||
* after encryption). |
|||
* |
|||
* Configuration: |
|||
* - Define WITH_ESPNOW_BRIDGE to enable this bridge |
|||
* - Define WITH_ESPNOW_BRIDGE_SECRET with a string to set the network encryption key |
|||
* |
|||
* Network Isolation: |
|||
* Multiple independent mesh networks can coexist by using different |
|||
* WITH_ESPNOW_BRIDGE_SECRET values. Packets encrypted with a different key will |
|||
* fail the checksum validation and be discarded. |
|||
*/ |
|||
class ESPNowBridge : public BridgeBase { |
|||
private: |
|||
static ESPNowBridge *_instance; |
|||
static void recv_cb(const uint8_t *mac, const uint8_t *data, int32_t len); |
|||
static void send_cb(const uint8_t *mac, esp_now_send_status_t status); |
|||
|
|||
/**
|
|||
* ESP-NOW Protocol Structure: |
|||
* - ESP-NOW header: 20 bytes (handled by ESP-NOW protocol) |
|||
* - ESP-NOW payload: 250 bytes maximum |
|||
* Total ESP-NOW packet: 270 bytes |
|||
* |
|||
* Our Bridge Packet Structure (must fit in ESP-NOW payload): |
|||
* - Magic header: 2 bytes |
|||
* - Checksum: 2 bytes |
|||
* - Available payload: 246 bytes |
|||
*/ |
|||
static const size_t MAX_ESPNOW_PACKET_SIZE = 250; |
|||
|
|||
/**
|
|||
* Size constants for packet parsing |
|||
*/ |
|||
static const size_t MAX_PAYLOAD_SIZE = MAX_ESPNOW_PACKET_SIZE - (BRIDGE_MAGIC_SIZE + BRIDGE_CHECKSUM_SIZE); |
|||
|
|||
/** Buffer for receiving ESP-NOW packets */ |
|||
uint8_t _rx_buffer[MAX_ESPNOW_PACKET_SIZE]; |
|||
|
|||
/** Current position in receive buffer */ |
|||
size_t _rx_buffer_pos; |
|||
|
|||
/**
|
|||
* Network encryption key from build define |
|||
* Must be defined with WITH_ESPNOW_BRIDGE_SECRET |
|||
* Used for XOR encryption to isolate different mesh networks |
|||
*/ |
|||
const char *_secret = WITH_ESPNOW_BRIDGE_SECRET; |
|||
|
|||
/**
|
|||
* Performs XOR encryption/decryption of data |
|||
* |
|||
* Uses WITH_ESPNOW_BRIDGE_SECRET as the key in a simple XOR operation. |
|||
* The same operation is used for both encryption and decryption. |
|||
* While not cryptographically secure, it provides basic network isolation. |
|||
* |
|||
* @param data Pointer to data to encrypt/decrypt |
|||
* @param len Length of data in bytes |
|||
*/ |
|||
void xorCrypt(uint8_t *data, size_t len); |
|||
|
|||
/**
|
|||
* ESP-NOW receive callback |
|||
* Called by ESP-NOW when a packet is received |
|||
* |
|||
* @param mac Source MAC address |
|||
* @param data Received data |
|||
* @param len Length of received data |
|||
*/ |
|||
void onDataRecv(const uint8_t *mac, const uint8_t *data, int32_t len); |
|||
|
|||
/**
|
|||
* ESP-NOW send callback |
|||
* Called by ESP-NOW after a transmission attempt |
|||
* |
|||
* @param mac_addr Destination MAC address |
|||
* @param status Transmission status |
|||
*/ |
|||
void onDataSent(const uint8_t *mac_addr, esp_now_send_status_t status); |
|||
|
|||
public: |
|||
/**
|
|||
* Constructs an ESPNowBridge instance |
|||
* |
|||
* @param mgr PacketManager for allocating and queuing packets |
|||
* @param rtc RTCClock for timestamping debug messages |
|||
*/ |
|||
ESPNowBridge(mesh::PacketManager *mgr, mesh::RTCClock *rtc); |
|||
|
|||
/**
|
|||
* Initializes the ESP-NOW bridge |
|||
* |
|||
* - Configures WiFi in station mode |
|||
* - Initializes ESP-NOW protocol |
|||
* - Registers callbacks |
|||
* - Sets up broadcast peer |
|||
*/ |
|||
void begin() override; |
|||
|
|||
/**
|
|||
* Main loop handler |
|||
* ESP-NOW is callback-based, so this is currently empty |
|||
*/ |
|||
void loop() override; |
|||
|
|||
/**
|
|||
* Called when a packet is received via ESP-NOW |
|||
* Queues the packet for mesh processing if not seen before |
|||
* |
|||
* @param packet The received mesh packet |
|||
*/ |
|||
void onPacketReceived(mesh::Packet *packet) override; |
|||
|
|||
/**
|
|||
* Called when a packet needs to be transmitted via ESP-NOW |
|||
* Encrypts and broadcasts the packet if not seen before |
|||
* |
|||
* @param packet The mesh packet to transmit |
|||
*/ |
|||
void onPacketTransmitted(mesh::Packet *packet) override; |
|||
}; |
|||
|
|||
#endif |
|||
@ -0,0 +1,147 @@ |
|||
#include "RS232Bridge.h" |
|||
|
|||
#include <HardwareSerial.h> |
|||
|
|||
#ifdef WITH_RS232_BRIDGE |
|||
|
|||
RS232Bridge::RS232Bridge(Stream &serial, mesh::PacketManager *mgr, mesh::RTCClock *rtc) |
|||
: BridgeBase(mgr, rtc), _serial(&serial) {} |
|||
|
|||
void RS232Bridge::begin() { |
|||
#if !defined(WITH_RS232_BRIDGE_RX) || !defined(WITH_RS232_BRIDGE_TX) |
|||
#error "WITH_RS232_BRIDGE_RX and WITH_RS232_BRIDGE_TX must be defined" |
|||
#endif |
|||
|
|||
#if defined(ESP32) |
|||
((HardwareSerial *)_serial)->setPins(WITH_RS232_BRIDGE_RX, WITH_RS232_BRIDGE_TX); |
|||
#elif defined(NRF52_PLATFORM) |
|||
((HardwareSerial *)_serial)->setPins(WITH_RS232_BRIDGE_RX, WITH_RS232_BRIDGE_TX); |
|||
#elif defined(RP2040_PLATFORM) |
|||
((SerialUART *)_serial)->setRX(WITH_RS232_BRIDGE_RX); |
|||
((SerialUART *)_serial)->setTX(WITH_RS232_BRIDGE_TX); |
|||
#elif defined(STM32_PLATFORM) |
|||
((HardwareSerial *)_serial)->setRx(WITH_RS232_BRIDGE_RX); |
|||
((HardwareSerial *)_serial)->setTx(WITH_RS232_BRIDGE_TX); |
|||
#else |
|||
#error RS232Bridge was not tested on the current platform |
|||
#endif |
|||
((HardwareSerial *)_serial)->begin(115200); |
|||
} |
|||
|
|||
void RS232Bridge::onPacketTransmitted(mesh::Packet *packet) { |
|||
// First validate the packet pointer
|
|||
if (!packet) { |
|||
#if MESH_PACKET_LOGGING |
|||
Serial.printf("%s: RS232 BRIDGE: TX invalid packet pointer\n", getLogDateTime()); |
|||
#endif |
|||
return; |
|||
} |
|||
|
|||
if (!_seen_packets.hasSeen(packet)) { |
|||
|
|||
uint8_t buffer[MAX_SERIAL_PACKET_SIZE]; |
|||
uint16_t len = packet->writeTo(buffer + 4); |
|||
|
|||
// Check if packet fits within our maximum payload size
|
|||
if (len > (MAX_TRANS_UNIT + 1)) { |
|||
#if MESH_PACKET_LOGGING |
|||
Serial.printf("%s: RS232 BRIDGE: TX packet too large (payload=%d, max=%d)\n", getLogDateTime(), len, |
|||
MAX_TRANS_UNIT + 1); |
|||
#endif |
|||
return; |
|||
} |
|||
|
|||
// Build packet header
|
|||
buffer[0] = (BRIDGE_PACKET_MAGIC >> 8) & 0xFF; // Magic high byte
|
|||
buffer[1] = BRIDGE_PACKET_MAGIC & 0xFF; // Magic low byte
|
|||
buffer[2] = (len >> 8) & 0xFF; // Length high byte
|
|||
buffer[3] = len & 0xFF; // Length low byte
|
|||
|
|||
// Calculate checksum over the payload
|
|||
uint16_t checksum = fletcher16(buffer + 4, len); |
|||
buffer[4 + len] = (checksum >> 8) & 0xFF; // Checksum high byte
|
|||
buffer[5 + len] = checksum & 0xFF; // Checksum low byte
|
|||
|
|||
// Send complete packet
|
|||
_serial->write(buffer, len + SERIAL_OVERHEAD); |
|||
|
|||
#if MESH_PACKET_LOGGING |
|||
Serial.printf("%s: RS232 BRIDGE: TX, len=%d crc=0x%04x\n", getLogDateTime(), len, checksum); |
|||
#endif |
|||
} |
|||
} |
|||
|
|||
void RS232Bridge::loop() { |
|||
while (_serial->available()) { |
|||
uint8_t b = _serial->read(); |
|||
|
|||
if (_rx_buffer_pos < 2) { |
|||
// Waiting for magic word
|
|||
if ((_rx_buffer_pos == 0 && b == ((BRIDGE_PACKET_MAGIC >> 8) & 0xFF)) || |
|||
(_rx_buffer_pos == 1 && b == (BRIDGE_PACKET_MAGIC & 0xFF))) { |
|||
_rx_buffer[_rx_buffer_pos++] = b; |
|||
} else { |
|||
// Invalid magic byte, reset and start over
|
|||
_rx_buffer_pos = 0; |
|||
// Check if this byte could be the start of a new magic word
|
|||
if (b == ((BRIDGE_PACKET_MAGIC >> 8) & 0xFF)) { |
|||
_rx_buffer[_rx_buffer_pos++] = b; |
|||
} |
|||
} |
|||
} else { |
|||
// Reading length, payload, and checksum
|
|||
_rx_buffer[_rx_buffer_pos++] = b; |
|||
|
|||
if (_rx_buffer_pos >= 4) { |
|||
uint16_t len = (_rx_buffer[2] << 8) | _rx_buffer[3]; |
|||
|
|||
// Validate length field
|
|||
if (len > (MAX_TRANS_UNIT + 1)) { |
|||
#if MESH_PACKET_LOGGING |
|||
Serial.printf("%s: RS232 BRIDGE: RX invalid length %d, resetting\n", getLogDateTime(), len); |
|||
#endif |
|||
_rx_buffer_pos = 0; // Invalid length, reset
|
|||
continue; |
|||
} |
|||
|
|||
if (_rx_buffer_pos == len + SERIAL_OVERHEAD) { // Full packet received
|
|||
uint16_t received_checksum = (_rx_buffer[4 + len] << 8) | _rx_buffer[5 + len]; |
|||
|
|||
if (validateChecksum(_rx_buffer + 4, len, received_checksum)) { |
|||
#if MESH_PACKET_LOGGING |
|||
Serial.printf("%s: RS232 BRIDGE: RX, len=%d crc=0x%04x\n", getLogDateTime(), len, |
|||
received_checksum); |
|||
#endif |
|||
mesh::Packet *pkt = _mgr->allocNew(); |
|||
if (pkt) { |
|||
if (pkt->readFrom(_rx_buffer + 4, len)) { |
|||
onPacketReceived(pkt); |
|||
} else { |
|||
#if MESH_PACKET_LOGGING |
|||
Serial.printf("%s: RS232 BRIDGE: RX failed to parse packet\n", getLogDateTime()); |
|||
#endif |
|||
_mgr->free(pkt); |
|||
} |
|||
} else { |
|||
#if MESH_PACKET_LOGGING |
|||
Serial.printf("%s: RS232 BRIDGE: RX failed to allocate packet\n", getLogDateTime()); |
|||
#endif |
|||
} |
|||
} else { |
|||
#if MESH_PACKET_LOGGING |
|||
Serial.printf("%s: RS232 BRIDGE: RX checksum mismatch, rcv=0x%04x\n", getLogDateTime(), |
|||
received_checksum); |
|||
#endif |
|||
} |
|||
_rx_buffer_pos = 0; // Reset for next packet
|
|||
} |
|||
} |
|||
} |
|||
} |
|||
} |
|||
|
|||
void RS232Bridge::onPacketReceived(mesh::Packet *packet) { |
|||
handleReceivedPacket(packet); |
|||
} |
|||
|
|||
#endif |
|||
@ -0,0 +1,141 @@ |
|||
#pragma once |
|||
|
|||
#include "helpers/bridges/BridgeBase.h" |
|||
|
|||
#include <Stream.h> |
|||
|
|||
#ifdef WITH_RS232_BRIDGE |
|||
|
|||
/**
|
|||
* @brief Bridge implementation using RS232/UART protocol for packet transport |
|||
* |
|||
* This bridge enables mesh packet transport over serial/UART connections, |
|||
* allowing nodes to communicate over wired serial links. It implements a simple |
|||
* packet framing protocol with checksums for reliable transfer. |
|||
* |
|||
* Features: |
|||
* - Point-to-point communication over hardware UART |
|||
* - Fletcher-16 checksum for data integrity verification |
|||
* - Magic header for packet synchronization and frame alignment |
|||
* - Duplicate packet detection using SimpleMeshTables tracking |
|||
* - Configurable RX/TX pins via build defines |
|||
* - Fixed baud rate at 115200 for consistent timing |
|||
* |
|||
* Packet Structure: |
|||
* [2 bytes] Magic Header (0xC03E) - Used to identify start of RS232Bridge packets |
|||
* [2 bytes] Payload Length - Length of the mesh packet payload |
|||
* [n bytes] Mesh Packet Payload - The actual mesh packet data |
|||
* [2 bytes] Fletcher-16 Checksum - Calculated over the payload for integrity verification |
|||
* |
|||
* The Fletcher-16 checksum is calculated over the mesh packet payload and provides |
|||
* error detection capabilities suitable for serial communication where electrical |
|||
* noise, timing issues, or hardware problems could corrupt data. The checksum |
|||
* validation ensures only valid packets are forwarded to the mesh. |
|||
* |
|||
* Configuration: |
|||
* - Define WITH_RS232_BRIDGE to enable this bridge |
|||
* - Define WITH_RS232_BRIDGE_RX with the RX pin number |
|||
* - Define WITH_RS232_BRIDGE_TX with the TX pin number |
|||
* |
|||
* Platform Support: |
|||
* Different platforms require different pin configuration methods: |
|||
* - ESP32: Uses HardwareSerial::setPins(rx, tx) |
|||
* - NRF52: Uses HardwareSerial::setPins(rx, tx) |
|||
* - RP2040: Uses SerialUART::setRX(rx) and SerialUART::setTX(tx) |
|||
* - STM32: Uses HardwareSerial::setRx(rx) and HardwareSerial::setTx(tx) |
|||
*/ |
|||
class RS232Bridge : public BridgeBase { |
|||
public: |
|||
/**
|
|||
* @brief Constructs an RS232Bridge instance |
|||
* |
|||
* @param serial The hardware serial port to use |
|||
* @param mgr PacketManager for allocating and queuing packets |
|||
* @param rtc RTCClock for timestamping debug messages |
|||
*/ |
|||
RS232Bridge(Stream &serial, mesh::PacketManager *mgr, mesh::RTCClock *rtc); |
|||
|
|||
/**
|
|||
* Initializes the RS232 bridge |
|||
* |
|||
* - Validates that RX/TX pins are defined |
|||
* - Configures UART pins based on target platform |
|||
* - Sets baud rate to 115200 for consistent communication |
|||
* - Platform-specific pin configuration methods are used |
|||
*/ |
|||
void begin() override; |
|||
|
|||
/**
|
|||
* @brief Main loop handler for processing incoming serial data |
|||
* |
|||
* Implements a state machine for packet reception: |
|||
* 1. Searches for magic header bytes for packet synchronization |
|||
* 2. Reads length field to determine expected packet size |
|||
* 3. Validates packet length against maximum allowed size |
|||
* 4. Receives complete packet payload and checksum |
|||
* 5. Validates Fletcher-16 checksum for data integrity |
|||
* 6. Creates mesh packet and forwards if valid |
|||
*/ |
|||
void loop() override; |
|||
|
|||
/**
|
|||
* @brief Called when a packet needs to be transmitted over serial |
|||
* |
|||
* Formats the mesh packet with RS232 framing protocol: |
|||
* - Adds magic header for synchronization |
|||
* - Includes payload length field |
|||
* - Calculates Fletcher-16 checksum over payload |
|||
* - Transmits complete framed packet |
|||
* - Uses duplicate detection to prevent retransmission |
|||
* |
|||
* @param packet The mesh packet to transmit |
|||
*/ |
|||
void onPacketTransmitted(mesh::Packet *packet) override; |
|||
|
|||
/**
|
|||
* @brief Called when a complete valid packet has been received from serial |
|||
* |
|||
* Forwards the received packet to the mesh for processing. |
|||
* The packet has already been validated for checksum integrity |
|||
* and parsed successfully at this point. |
|||
* |
|||
* @param packet The received mesh packet ready for processing |
|||
*/ |
|||
void onPacketReceived(mesh::Packet *packet) override; |
|||
|
|||
private: |
|||
/**
|
|||
* RS232 Protocol Structure: |
|||
* - Magic header: 2 bytes (packet identification) |
|||
* - Length field: 2 bytes (payload length) |
|||
* - Payload: variable bytes (mesh packet data) |
|||
* - Checksum: 2 bytes (Fletcher-16 over payload) |
|||
* Total overhead: 6 bytes |
|||
*/ |
|||
|
|||
/**
|
|||
* @brief The total overhead of the serial protocol in bytes. |
|||
* Includes: MAGIC_WORD (2) + LENGTH (2) + CHECKSUM (2) = 6 bytes |
|||
*/ |
|||
static constexpr uint16_t SERIAL_OVERHEAD = BRIDGE_MAGIC_SIZE + BRIDGE_LENGTH_SIZE + BRIDGE_CHECKSUM_SIZE; |
|||
|
|||
/**
|
|||
* @brief The maximum size of a complete packet on the serial line. |
|||
* |
|||
* This is calculated as the sum of: |
|||
* - MAX_TRANS_UNIT + 1 for the maximum mesh packet size |
|||
* - SERIAL_OVERHEAD for the framing (magic + length + checksum) |
|||
*/ |
|||
static constexpr uint16_t MAX_SERIAL_PACKET_SIZE = (MAX_TRANS_UNIT + 1) + SERIAL_OVERHEAD; |
|||
|
|||
/** Hardware serial port interface */ |
|||
Stream *_serial; |
|||
|
|||
/** Buffer for building received packets */ |
|||
uint8_t _rx_buffer[MAX_SERIAL_PACKET_SIZE]; |
|||
|
|||
/** Current position in the receive buffer */ |
|||
uint16_t _rx_buffer_pos = 0; |
|||
}; |
|||
|
|||
#endif |
|||
@ -0,0 +1,81 @@ |
|||
#include <Arduino.h> |
|||
#include "RAKWismeshTagBoard.h" |
|||
|
|||
#include <bluefruit.h> |
|||
#include <Wire.h> |
|||
|
|||
static BLEDfu bledfu; |
|||
|
|||
static void connect_callback(uint16_t conn_handle) { |
|||
(void)conn_handle; |
|||
MESH_DEBUG_PRINTLN("BLE client connected"); |
|||
} |
|||
|
|||
static void disconnect_callback(uint16_t conn_handle, uint8_t reason) { |
|||
(void)conn_handle; |
|||
(void)reason; |
|||
|
|||
MESH_DEBUG_PRINTLN("BLE client disconnected"); |
|||
} |
|||
|
|||
void RAKWismeshTagBoard::begin() { |
|||
// for future use, sub-classes SHOULD call this from their begin()
|
|||
startup_reason = BD_STARTUP_NORMAL; |
|||
pinMode(PIN_VBAT_READ, INPUT); |
|||
pinMode(PIN_USER_BTN, INPUT_PULLUP); |
|||
|
|||
Wire.setPins(PIN_BOARD_SDA, PIN_BOARD_SCL); |
|||
Wire.begin(); |
|||
|
|||
pinMode(SX126X_POWER_EN, OUTPUT); |
|||
digitalWrite(SX126X_POWER_EN, HIGH); |
|||
delay(10); // give sx1262 some time to power up
|
|||
} |
|||
|
|||
bool RAKWismeshTagBoard::startOTAUpdate(const char* id, char reply[]) { |
|||
// Config the peripheral connection with maximum bandwidth
|
|||
// more SRAM required by SoftDevice
|
|||
// Note: All config***() function must be called before begin()
|
|||
Bluefruit.configPrphBandwidth(BANDWIDTH_MAX); |
|||
Bluefruit.configPrphConn(92, BLE_GAP_EVENT_LENGTH_MIN, 16, 16); |
|||
|
|||
Bluefruit.begin(1, 0); |
|||
// Set max power. Accepted values are: -40, -30, -20, -16, -12, -8, -4, 0, 4
|
|||
Bluefruit.setTxPower(4); |
|||
// Set the BLE device name
|
|||
Bluefruit.setName("WISMESHTAG_OTA"); |
|||
|
|||
Bluefruit.Periph.setConnectCallback(connect_callback); |
|||
Bluefruit.Periph.setDisconnectCallback(disconnect_callback); |
|||
|
|||
// To be consistent OTA DFU should be added first if it exists
|
|||
bledfu.begin(); |
|||
|
|||
// Set up and start advertising
|
|||
// Advertising packet
|
|||
Bluefruit.Advertising.addFlags(BLE_GAP_ADV_FLAGS_LE_ONLY_GENERAL_DISC_MODE); |
|||
Bluefruit.Advertising.addTxPower(); |
|||
Bluefruit.Advertising.addName(); |
|||
|
|||
/* Start Advertising
|
|||
- Enable auto advertising if disconnected |
|||
- Interval: fast mode = 20 ms, slow mode = 152.5 ms |
|||
- Timeout for fast mode is 30 seconds |
|||
- Start(timeout) with timeout = 0 will advertise forever (until connected) |
|||
|
|||
For recommended advertising interval |
|||
https://developer.apple.com/library/content/qa/qa1931/_index.html
|
|||
*/ |
|||
Bluefruit.Advertising.restartOnDisconnect(true); |
|||
Bluefruit.Advertising.setInterval(32, 244); // in unit of 0.625 ms
|
|||
Bluefruit.Advertising.setFastTimeout(30); // number of seconds in fast mode
|
|||
Bluefruit.Advertising.start(0); // 0 = Don't stop advertising after n seconds
|
|||
|
|||
uint8_t mac_addr[6]; |
|||
memset(mac_addr, 0, sizeof(mac_addr)); |
|||
Bluefruit.getAddr(mac_addr); |
|||
sprintf(reply, "OK - mac: %02X:%02X:%02X:%02X:%02X:%02X", |
|||
mac_addr[5], mac_addr[4], mac_addr[3], mac_addr[2], mac_addr[1], mac_addr[0]); |
|||
|
|||
return true; |
|||
} |
|||
@ -0,0 +1,80 @@ |
|||
#pragma once |
|||
|
|||
#include <MeshCore.h> |
|||
#include <Arduino.h> |
|||
|
|||
// built-ins
|
|||
#define PIN_VBAT_READ 5 |
|||
#define ADC_MULTIPLIER (3 * 1.73 * 1.187 * 1000) |
|||
|
|||
class RAKWismeshTagBoard : public mesh::MainBoard { |
|||
protected: |
|||
uint8_t startup_reason; |
|||
|
|||
public: |
|||
void begin(); |
|||
uint8_t getStartupReason() const override { return startup_reason; } |
|||
|
|||
#if defined(P_LORA_TX_LED) && defined(LED_STATE_ON) |
|||
void onBeforeTransmit() override { |
|||
digitalWrite(P_LORA_TX_LED, LED_STATE_ON); // turn TX LED on
|
|||
} |
|||
void onAfterTransmit() override { |
|||
digitalWrite(P_LORA_TX_LED, !LED_STATE_ON); // turn TX LED off
|
|||
} |
|||
#endif |
|||
|
|||
#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 "RAK WisMesh Tag"; |
|||
} |
|||
|
|||
void reboot() override { |
|||
NVIC_SystemReset(); |
|||
} |
|||
|
|||
bool startOTAUpdate(const char* id, char reply[]) override; |
|||
|
|||
void powerOff() override { |
|||
#ifdef BUZZER_EN |
|||
digitalWrite(BUZZER_EN, LOW); |
|||
#endif |
|||
|
|||
#ifdef PIN_GPS_EN |
|||
digitalWrite(PIN_GPS_EN, LOW); |
|||
#endif |
|||
|
|||
// set led on and wait for button release before poweroff
|
|||
#ifdef LED_PIN |
|||
digitalWrite(LED_PIN, HIGH); |
|||
#endif |
|||
#ifdef BUTTON_PIN |
|||
while(digitalRead(BUTTON_PIN)); |
|||
#endif |
|||
#ifdef LED_GREEN |
|||
digitalWrite(LED_GREEN, LOW); |
|||
#endif |
|||
#ifdef LED_BLUE |
|||
digitalWrite(LED_BLUE, LOW); |
|||
#endif |
|||
|
|||
#ifdef BUTTON_PIN |
|||
nrf_gpio_cfg_sense_input(digitalPinToInterrupt(BUTTON_PIN), NRF_GPIO_PIN_NOPULL, NRF_GPIO_PIN_SENSE_HIGH); |
|||
#endif |
|||
|
|||
sd_power_system_off(); |
|||
} |
|||
}; |
|||
@ -0,0 +1,116 @@ |
|||
[rak_wismesh_tag] |
|||
extends = nrf52_base |
|||
platform = https://github.com/maxgerhardt/platform-nordicnrf52.git#rak |
|||
board = wiscore_rak4631 |
|||
board_check = true |
|||
build_flags = ${nrf52_base.build_flags} |
|||
${sensor_base.build_flags} |
|||
-I variants/rak_wismesh_tag |
|||
-I src/helpers/ui |
|||
-D RAK_WISMESH_TAG |
|||
-D RAK_BOARD |
|||
-D P_LORA_TX_LED=LED_GREEN |
|||
-D P_LORA_DIO_1=SX126X_DIO1 |
|||
-D P_LORA_NSS=PIN_SPI_NSS |
|||
-D P_LORA_RESET=SX126X_RESET |
|||
-D P_LORA_BUSY=SX126X_BUSY |
|||
-D P_LORA_SCLK=PIN_SPI_SCK |
|||
-D P_LORA_MISO=PIN_SPI_MISO |
|||
-D P_LORA_MOSI=PIN_SPI_MOSI |
|||
-D RADIO_CLASS=CustomSX1262 |
|||
-D WRAPPER_CLASS=CustomSX1262Wrapper |
|||
-D DISPLAY_CLASS=NullDisplayDriver |
|||
-D LORA_TX_POWER=22 |
|||
-D SX126X_CURRENT_LIMIT=140 |
|||
-D SX126X_RX_BOOSTED_GAIN=1 |
|||
-D PIN_BUZZER=21 |
|||
-D PIN_BOARD_SDA=PIN_WIRE_SDA |
|||
-D PIN_BOARD_SCL=PIN_WIRE_SCL |
|||
build_src_filter = ${nrf52_base.build_src_filter} |
|||
+<../variants/rak_wismesh_tag> |
|||
+<helpers/ui/buzzer.cpp> |
|||
+<helpers/ui/MomentaryButton.cpp> |
|||
+<helpers/ui/NullDisplayDriver.cpp> |
|||
+<helpers/sensors> |
|||
lib_deps = |
|||
${nrf52_base.lib_deps} |
|||
${sensor_base.lib_deps} |
|||
|
|||
[env:RAK_WisMesh_Tag_Repeater] |
|||
extends = rak_wismesh_tag |
|||
build_flags = |
|||
${rak_wismesh_tag.build_flags} |
|||
-D ADVERT_NAME='"RAK WM Repeater"' |
|||
-D ADVERT_LAT=0.0 |
|||
-D ADVERT_LON=0.0 |
|||
-D ADMIN_PASSWORD='"password"' |
|||
-D MAX_NEIGHBOURS=8 |
|||
; -D MESH_PACKET_LOGGING=1 |
|||
; -D MESH_DEBUG=1 |
|||
build_src_filter = ${rak_wismesh_tag.build_src_filter} |
|||
+<../examples/simple_repeater> |
|||
|
|||
[env:RAK_WisMesh_Tag_room_server] |
|||
extends = rak_wismesh_tag |
|||
build_flags = |
|||
${rak_wismesh_tag.build_flags} |
|||
-D ADVERT_NAME='"RAK WM 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 = ${rak_wismesh_tag.build_src_filter} |
|||
+<../examples/simple_room_server> |
|||
|
|||
[env:RAK_WisMesh_Tag_companion_radio_usb] |
|||
extends = rak_wismesh_tag |
|||
build_flags = |
|||
${rak_wismesh_tag.build_flags} |
|||
-I examples/companion_radio/ui-orig |
|||
-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 = ${rak_wismesh_tag.build_src_filter} |
|||
+<../examples/companion_radio/*.cpp> |
|||
+<../examples/companion_radio/ui-orig/*.cpp> |
|||
lib_deps = |
|||
${rak_wismesh_tag.lib_deps} |
|||
densaugeo/base64 @ ~1.4.0 |
|||
end2endzone/NonBlockingRTTTL@^1.3.0 |
|||
|
|||
[env:RAK_WisMesh_Tag_companion_radio_ble] |
|||
extends = rak_wismesh_tag |
|||
build_flags = |
|||
${rak_wismesh_tag.build_flags} |
|||
-I examples/companion_radio/ui-orig |
|||
-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 = ${rak_wismesh_tag.build_src_filter} |
|||
+<helpers/nrf52/SerialBLEInterface.cpp> |
|||
+<../examples/companion_radio/*.cpp> |
|||
+<../examples/companion_radio/ui-orig/*.cpp> |
|||
lib_deps = |
|||
${rak4631.lib_deps} |
|||
densaugeo/base64 @ ~1.4.0 |
|||
end2endzone/NonBlockingRTTTL@^1.3.0 |
|||
|
|||
[env:RAK_WisMesh_Tag_sensor] |
|||
extends = rak4631 |
|||
build_flags = |
|||
${rak4631.build_flags} |
|||
-D ADVERT_NAME='"RAK WM Sensor"' |
|||
-D ADVERT_LAT=0.0 |
|||
-D ADVERT_LON=0.0 |
|||
-D ADMIN_PASSWORD='"password"' |
|||
; -D MESH_PACKET_LOGGING=1 |
|||
-D MESH_DEBUG=1 |
|||
build_src_filter = ${rak4631.build_src_filter} |
|||
+<../examples/simple_sensor> |
|||
@ -0,0 +1,54 @@ |
|||
#include <Arduino.h> |
|||
#include "target.h" |
|||
#include <helpers/ArduinoHelpers.h> |
|||
|
|||
RAKWismeshTagBoard 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, 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); |
|||
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(uint8_t dbm) { |
|||
radio.setOutputPower(dbm); |
|||
} |
|||
|
|||
mesh::LocalIdentity radio_new_identity() { |
|||
RadioNoiseListener rng(radio); |
|||
return mesh::LocalIdentity(&rng); // create new random identity
|
|||
} |
|||
@ -0,0 +1,27 @@ |
|||
#pragma once |
|||
|
|||
#define RADIOLIB_STATIC_ONLY 1 |
|||
#include <RadioLib.h> |
|||
#include <helpers/radiolib/RadioLibWrappers.h> |
|||
#include <RAKWismeshTagBoard.h> |
|||
#include <helpers/radiolib/CustomSX1262Wrapper.h> |
|||
#include <helpers/AutoDiscoverRTCClock.h> |
|||
#include <helpers/sensors/EnvironmentSensorManager.h> |
|||
|
|||
#ifdef DISPLAY_CLASS |
|||
#include <helpers/ui/NullDisplayDriver.h> |
|||
extern DISPLAY_CLASS display; |
|||
#include <helpers/ui/MomentaryButton.h> |
|||
extern MomentaryButton user_btn; |
|||
#endif |
|||
|
|||
extern RAKWismeshTagBoard 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(uint8_t dbm); |
|||
mesh::LocalIdentity radio_new_identity(); |
|||
@ -0,0 +1,21 @@ |
|||
#include "variant.h" |
|||
#include "nrf.h" |
|||
#include "wiring_constants.h" |
|||
#include "wiring_digital.h" |
|||
|
|||
const uint32_t g_ADigitalPinMap[] = { |
|||
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, |
|||
32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47 |
|||
}; |
|||
|
|||
void initVariant() { |
|||
// LEDs
|
|||
pinMode(LED_BLUE, OUTPUT); |
|||
pinMode(LED_GREEN, OUTPUT); |
|||
digitalWrite(LED_BLUE, LOW); |
|||
digitalWrite(LED_GREEN, LOW); |
|||
|
|||
// GPS
|
|||
pinMode(PIN_GPS_EN, OUTPUT); |
|||
digitalWrite(PIN_GPS_EN, HIGH); |
|||
} |
|||
@ -0,0 +1,121 @@ |
|||
/*
|
|||
* variant.h |
|||
* Copyright (C) 2023 Seeed K.K. |
|||
* MIT License |
|||
*/ |
|||
|
|||
#pragma once |
|||
|
|||
#include "WVariant.h" |
|||
|
|||
////////////////////////////////////////////////////////////////////////////////
|
|||
// Low frequency clock source
|
|||
|
|||
#define USE_LFXO // 32.768 kHz crystal oscillator
|
|||
#define VARIANT_MCK (64000000ul) |
|||
|
|||
#define WIRE_INTERFACES_COUNT (1) |
|||
#define PIN_TXCO (21) |
|||
////////////////////////////////////////////////////////////////////////////////
|
|||
// Power
|
|||
|
|||
#define PIN_PWR_EN (12) |
|||
|
|||
#define BATTERY_PIN (5) |
|||
#define ADC_MULTIPLIER (1.73F) |
|||
|
|||
#define ADC_RESOLUTION (14) |
|||
#define BATTERY_SENSE_RES (12) |
|||
|
|||
#define AREF_VOLTAGE (3.0) |
|||
|
|||
////////////////////////////////////////////////////////////////////////////////
|
|||
// Number of pins
|
|||
|
|||
#define PINS_COUNT (48) |
|||
#define NUM_DIGITAL_PINS (48) |
|||
#define NUM_ANALOG_INPUTS (6) |
|||
#define NUM_ANALOG_OUTPUTS (0) |
|||
|
|||
////////////////////////////////////////////////////////////////////////////////
|
|||
// UART pin definition
|
|||
|
|||
#define PIN_SERIAL1_RX (15) |
|||
#define PIN_SERIAL1_TX (16) |
|||
|
|||
////////////////////////////////////////////////////////////////////////////////
|
|||
// I2C pin definition
|
|||
#define WIRE_INTERFACES_COUNT (1) |
|||
#define PIN_WIRE_SDA (25) |
|||
#define PIN_WIRE_SCL (24) |
|||
|
|||
////////////////////////////////////////////////////////////////////////////////
|
|||
// SPI pin definition
|
|||
|
|||
#define SPI_INTERFACES_COUNT (2) |
|||
|
|||
#define PIN_SPI_MISO (45) |
|||
#define PIN_SPI_MOSI (44) |
|||
#define PIN_SPI_SCK (43) |
|||
#define PIN_SPI_NSS (42) |
|||
|
|||
////////////////////////////////////////////////////////////////////////////////
|
|||
// Builtin LEDs
|
|||
|
|||
#define LED_RED (-1) |
|||
#define LED_BLUE (36) |
|||
#define LED_GREEN (35) |
|||
|
|||
//#define PIN_STATUS_LED LED_BLUE
|
|||
#define LED_BUILTIN LED_GREEN |
|||
#define LED_PIN LED_GREEN |
|||
#define LED_STATE_ON HIGH |
|||
|
|||
////////////////////////////////////////////////////////////////////////////////
|
|||
// Builtin buttons
|
|||
|
|||
#define PIN_BUTTON1 (9) |
|||
#define BUTTON_PIN PIN_BUTTON1 |
|||
#define PIN_USER_BTN BUTTON_PIN |
|||
|
|||
#define PIN_BUTTON2 (12) |
|||
#define BUTTON_PIN2 PIN_BUTTON2 |
|||
|
|||
////////////////////////////////////////////////////////////////////////////////
|
|||
// Lora
|
|||
|
|||
#define USE_SX1262 |
|||
#define LORA_CS (42) |
|||
#define SX126X_DIO1 (47) |
|||
#define SX126X_BUSY (46) |
|||
#define SX126X_RESET (38) |
|||
#define SX126X_POWER_EN (37) |
|||
#define SX126X_DIO2_AS_RF_SWITCH |
|||
#define SX126X_DIO3_TCXO_VOLTAGE 1.8 |
|||
|
|||
////////////////////////////////////////////////////////////////////////////////
|
|||
// SPI1
|
|||
|
|||
#define PIN_SPI1_MISO (29) |
|||
#define PIN_SPI1_MOSI (30) |
|||
#define PIN_SPI1_SCK (3) |
|||
|
|||
// GxEPD2 needs that for a panel that is not even used !
|
|||
extern const int MISO; |
|||
extern const int MOSI; |
|||
extern const int SCK; |
|||
|
|||
////////////////////////////////////////////////////////////////////////////////
|
|||
// GPS
|
|||
|
|||
#define PIN_GPS_RX (PIN_SERIAL1_TX) |
|||
#define PIN_GPS_TX (PIN_SERIAL1_RX) |
|||
#define PIN_GPS_PPS (17) |
|||
#define PIN_GPS_EN (34) |
|||
|
|||
///////////////////////////////////////////////////////////////////////////////
|
|||
// OTHER PINS
|
|||
#define PIN_AREF (2) |
|||
#define PIN_NFC1 (9) |
|||
#define PIN_NFC2 (10) |
|||
#define PIN_BUZZER (21) |
|||
@ -1,119 +1,99 @@ |
|||
#include <Arduino.h> |
|||
#include "t1000e_sensors.h" |
|||
|
|||
#define HEATER_NTC_BX 4250 // thermistor coefficient B
|
|||
#define HEATER_NTC_RP 8250 // ohm, series resistance to thermistor
|
|||
#define HEATER_NTC_KA 273.15 // 25 Celsius at Kelvin
|
|||
#define NTC_REF_VCC 3000 // mV, output voltage of LDO
|
|||
#define LIGHT_REF_VCC 2400 //
|
|||
|
|||
static unsigned int ntc_res2[136]={ |
|||
113347,107565,102116,96978,92132,87559,83242,79166,75316,71677, |
|||
68237,64991,61919,59011,56258,53650,51178,48835,46613,44506, |
|||
42506,40600,38791,37073,35442,33892,32420,31020,29689,28423, |
|||
27219,26076,24988,23951,22963,22021,21123,20267,19450,18670, |
|||
17926,17214,16534,15886,15266,14674,14108,13566,13049,12554, |
|||
12081,11628,11195,10780,10382,10000,9634,9284,8947,8624, |
|||
8315,8018,7734,7461,7199,6948,6707,6475,6253,6039, |
|||
5834,5636,5445,5262,5086,4917,4754,4597,4446,4301, |
|||
4161,4026,3896,3771,3651,3535,3423,3315,3211,3111, |
|||
3014,2922,2834,2748,2666,2586,2509,2435,2364,2294, |
|||
2228,2163,2100,2040,1981,1925,1870,1817,1766,1716, |
|||
1669,1622,1578,1535,1493,1452,1413,1375,1338,1303, |
|||
1268,1234,1202,1170,1139,1110,1081,1053,1026,999, |
|||
974,949,925,902,880,858, |
|||
#include <Arduino.h> |
|||
|
|||
#define HEATER_NTC_BX 4250 // thermistor coefficient B
|
|||
#define HEATER_NTC_RP 8250 // ohm, series resistance to thermistor
|
|||
#define HEATER_NTC_KA 273.15 // 25 Celsius at Kelvin
|
|||
#define NTC_REF_VCC 3000 // mV, output voltage of LDO
|
|||
#define LIGHT_REF_VCC 2400 //
|
|||
|
|||
static unsigned int ntc_res2[136] = { |
|||
113347, 107565, 102116, 96978, 92132, 87559, 83242, 79166, 75316, 71677, 68237, 64991, 61919, 59011, |
|||
56258, 53650, 51178, 48835, 46613, 44506, 42506, 40600, 38791, 37073, 35442, 33892, 32420, 31020, |
|||
29689, 28423, 27219, 26076, 24988, 23951, 22963, 22021, 21123, 20267, 19450, 18670, 17926, 17214, |
|||
16534, 15886, 15266, 14674, 14108, 13566, 13049, 12554, 12081, 11628, 11195, 10780, 10382, 10000, |
|||
9634, 9284, 8947, 8624, 8315, 8018, 7734, 7461, 7199, 6948, 6707, 6475, 6253, 6039, |
|||
5834, 5636, 5445, 5262, 5086, 4917, 4754, 4597, 4446, 4301, 4161, 4026, 3896, 3771, |
|||
3651, 3535, 3423, 3315, 3211, 3111, 3014, 2922, 2834, 2748, 2666, 2586, 2509, 2435, |
|||
2364, 2294, 2228, 2163, 2100, 2040, 1981, 1925, 1870, 1817, 1766, 1716, 1669, 1622, |
|||
1578, 1535, 1493, 1452, 1413, 1375, 1338, 1303, 1268, 1234, 1202, 1170, 1139, 1110, |
|||
1081, 1053, 1026, 999, 974, 949, 925, 902, 880, 858, |
|||
}; |
|||
|
|||
static char ntc_temp2[136]= |
|||
{ |
|||
-30,-29,-28,-27,-26,-25,-24,-23,-22,-21, |
|||
-20,-19,-18,-17,-16,-15,-14,-13,-12,-11, |
|||
-10,-9,-8,-7,-6,-5,-4,-3,-2,-1, |
|||
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,32,33,34,35,36,37,38,39, |
|||
40,41,42,43,44,45,46,47,48,49, |
|||
50,51,52,53,54,55,56,57,58,59, |
|||
60,61,62,63,64,65,66,67,68,69, |
|||
70,71,72,73,74,75,76,77,78,79, |
|||
80,81,82,83,84,85,86,87,88,89, |
|||
90,91,92,93,94,95,96,97,98,99, |
|||
100,101,102,103,104,105, |
|||
|
|||
static char ntc_temp2[136] = { |
|||
-30, -29, -28, -27, -26, -25, -24, -23, -22, -21, -20, -19, -18, -17, -16, -15, -14, -13, -12, -11, |
|||
-10, -9, -8, -7, -6, -5, -4, -3, -2, -1, 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, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, |
|||
50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, |
|||
70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, |
|||
90, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104, 105, |
|||
}; |
|||
|
|||
static float get_heater_temperature( unsigned int vcc_volt, unsigned int ntc_volt ) |
|||
{ |
|||
int i = 0; |
|||
float Vout = 0, Rt = 0, temp = 0; |
|||
Vout = ntc_volt; |
|||
|
|||
Rt = ( HEATER_NTC_RP * vcc_volt ) / Vout - HEATER_NTC_RP; |
|||
|
|||
for( i = 0; i < 136; i++ ) |
|||
{ |
|||
if( Rt >= ntc_res2[i] ) |
|||
{ |
|||
break; |
|||
} |
|||
static float get_heater_temperature(unsigned int vcc_volt, unsigned int ntc_volt) { |
|||
int i = 0; |
|||
float Vout = 0, Rt = 0, temp = 0; |
|||
Vout = ntc_volt; |
|||
|
|||
Rt = (HEATER_NTC_RP * vcc_volt) / Vout - HEATER_NTC_RP; |
|||
|
|||
for (i = 0; i < 136; i++) { |
|||
if (Rt >= ntc_res2[i]) { |
|||
break; |
|||
} |
|||
|
|||
temp = ntc_temp2[i - 1] + 1 * ( ntc_res2[i - 1] - Rt ) / ( float )( ntc_res2[i - 1] - ntc_res2[i] ); |
|||
|
|||
temp = ( temp * 100 + 5 ) / 100; |
|||
return temp; |
|||
} |
|||
|
|||
temp = ntc_temp2[i - 1] + 1 * (ntc_res2[i - 1] - Rt) / (float)(ntc_res2[i - 1] - ntc_res2[i]); |
|||
|
|||
temp = (temp * 100 + 5) / 100; |
|||
return temp; |
|||
} |
|||
|
|||
static int get_light_lv( unsigned int light_volt ) |
|||
{ |
|||
float Vout = 0, Vin = 0, Rt = 0, temp = 0; |
|||
unsigned int light_level = 0; |
|||
|
|||
if( light_volt <= 80 ) |
|||
{ |
|||
light_level = 0; |
|||
return light_level; |
|||
} |
|||
else if( light_volt >= 2480 ) |
|||
{ |
|||
light_level = 100; |
|||
return light_level; |
|||
} |
|||
Vout = light_volt; |
|||
light_level = 100 * ( Vout - 80 ) / LIGHT_REF_VCC; |
|||
|
|||
static int get_light_lv(unsigned int light_volt) { |
|||
float Vout = 0, Vin = 0, Rt = 0, temp = 0; |
|||
unsigned int light_level = 0; |
|||
|
|||
if (light_volt <= 80) { |
|||
light_level = 0; |
|||
return light_level; |
|||
} else if (light_volt >= 2480) { |
|||
light_level = 100; |
|||
return light_level; |
|||
} |
|||
|
|||
float t1000e_get_temperature( void ) |
|||
{ |
|||
unsigned int ntc_v, vcc_v; |
|||
|
|||
digitalWrite(PIN_3V3_EN, HIGH); |
|||
digitalWrite(SENSOR_EN, HIGH); |
|||
analogReference(AR_INTERNAL_3_0); |
|||
analogReadResolution(12); |
|||
delay(10); |
|||
vcc_v = (1000.0*(analogRead(BATTERY_PIN) * ADC_MULTIPLIER * AREF_VOLTAGE)) / 4096; |
|||
ntc_v = (1000.0 * AREF_VOLTAGE * analogRead(TEMP_SENSOR)) / 4096; |
|||
digitalWrite(PIN_3V3_EN, LOW); |
|||
digitalWrite(SENSOR_EN, LOW); |
|||
|
|||
return get_heater_temperature (vcc_v, ntc_v); |
|||
} |
|||
Vout = light_volt; |
|||
light_level = 100 * (Vout - 80) / LIGHT_REF_VCC; |
|||
|
|||
return light_level; |
|||
} |
|||
|
|||
float t1000e_get_temperature(void) { |
|||
unsigned int ntc_v, vcc_v; |
|||
|
|||
digitalWrite(PIN_3V3_EN, HIGH); |
|||
digitalWrite(SENSOR_EN, HIGH); |
|||
analogReference(AR_INTERNAL_3_0); |
|||
analogReadResolution(12); |
|||
delay(10); |
|||
vcc_v = (1000.0 * (analogRead(BATTERY_PIN) * ADC_MULTIPLIER * AREF_VOLTAGE)) / 4096; |
|||
ntc_v = (1000.0 * AREF_VOLTAGE * analogRead(TEMP_SENSOR)) / 4096; |
|||
digitalWrite(PIN_3V3_EN, LOW); |
|||
digitalWrite(SENSOR_EN, LOW); |
|||
|
|||
return get_heater_temperature(vcc_v, ntc_v); |
|||
} |
|||
|
|||
uint32_t t1000e_get_light( void ) |
|||
{ |
|||
int lux = 0; |
|||
unsigned int lux_v = 0; |
|||
|
|||
digitalWrite(SENSOR_EN, HIGH); |
|||
analogReference(AR_INTERNAL_3_0); |
|||
analogReadResolution(12); |
|||
delay(10); |
|||
lux_v = 1000 * analogRead(LUX_SENSOR) * AREF_VOLTAGE / 4096; |
|||
lux = get_light_lv( lux_v ); |
|||
digitalWrite(SENSOR_EN, LOW); |
|||
|
|||
return lux; |
|||
uint32_t t1000e_get_light(void) { |
|||
int lux = 0; |
|||
unsigned int lux_v = 0; |
|||
|
|||
digitalWrite(SENSOR_EN, HIGH); |
|||
analogReference(AR_INTERNAL_3_0); |
|||
analogReadResolution(12); |
|||
delay(10); |
|||
lux_v = 1000 * analogRead(LUX_SENSOR) * AREF_VOLTAGE / 4096; |
|||
lux = get_light_lv(lux_v); |
|||
digitalWrite(SENSOR_EN, LOW); |
|||
|
|||
return lux; |
|||
} |
|||
@ -1,7 +1,8 @@ |
|||
#pragma once |
|||
#include <stdint.h> |
|||
|
|||
// Light and temperature sensors are on ADC ports
|
|||
// functions adapted from Seeed examples to get values
|
|||
// functions adapted from Seeed examples to get values
|
|||
// see : https://github.com/Seeed-Studio/Seeed-Tracker-T1000-E-for-LoRaWAN-dev-board
|
|||
|
|||
extern uint32_t t1000e_get_light(); |
|||
|
|||
Loading…
Reference in new issue