meshcore-dev/MeshCore
1
0
Fork 0
mirror of https://github.com/meshcore-dev/MeshCore.git synced 2026-04-20 22:13:47 +00:00
Code Issues Projects Releases Packages Wiki Activity

Add native Ethernet support for RAK4631 repeater, room server, and companion

Browse source 
Add W5100S Ethernet adapter support for RAK4631-based firmware, enabling
TCP CLI access on port 23 as an alternative to BLE/Serial connections.

- New SerialEthernetInterface for nRF52 with DHCP, reconnection handling,
  and shared WB_IO2 power pin management with GPS module
- Ethernet build targets for repeater, room server, and companion firmware
- Prevent GPS from toggling WB_IO2 when Ethernet module is active
- CI build check for all three ETH firmware targets

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
Ryan Gregg 2026-03-09 14:52:01 -07:00
parent a10476efd7
commit 70b51bd096
9 changed files with 842 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

3
.github/workflows/pr-build-check.yml vendored
View file

@ -23,8 +23,11 @@ jobs:
- Heltec_v3_room_server
# nRF52
- RAK_4631_companion_radio_ble
- RAK_4631_companion_radio_eth
- RAK_4631_repeater
- RAK_4631_repeater_eth
- RAK_4631_room_server
- RAK_4631_room_server_eth
# RP2040
- PicoW_repeater
# STM32

56
examples/companion_radio/main.cpp
View file

@ -12,19 +12,21 @@ static uint32_t _atoi(const char* sp) {
return n;
}
uint32_t tick_count = 0;
#if defined(NRF52_PLATFORM) || defined(STM32_PLATFORM)
#include <InternalFileSystem.h>
#if defined(QSPIFLASH)
#include <CustomLFS_QSPIFlash.h>
DataStore store(InternalFS, QSPIFlash, rtc_clock);
#else
#if defined(EXTRAFS)
#include <CustomLFS.h>
CustomLFS ExtraFS(0xD4000, 0x19000, 128);
DataStore store(InternalFS, ExtraFS, rtc_clock);
#else
DataStore store(InternalFS, rtc_clock);
#endif
#if defined(EXTRAFS)
#include <CustomLFS.h>
CustomLFS ExtraFS(0xD4000, 0x19000, 128);
DataStore store(InternalFS, ExtraFS, rtc_clock);
#else
DataStore store(InternalFS, rtc_clock);
#endif
#endif
#elif defined(RP2040_PLATFORM)
#include <LittleFS.h>
@ -74,13 +76,21 @@ static uint32_t _atoi(const char* sp) {
#ifdef BLE_PIN_CODE
#include <helpers/nrf52/SerialBLEInterface.h>
SerialBLEInterface serial_interface;
#elif defined(ETH_ENABLED)
#include <helpers/nrf52/SerialEthernetInterface.h>
SerialEthernetInterface serial_interface;
#else
#include <helpers/ArduinoSerialInterface.h>
ArduinoSerialInterface serial_interface;
#endif
#elif defined(STM32_PLATFORM)
#include <helpers/ArduinoSerialInterface.h>
ArduinoSerialInterface serial_interface;
#ifdef ETH_ENABLED
#include <helpers/nrf52/SerialEthernetInterface.h>
SerialEthernetInterface serial_interface;
#elif
#include <helpers/ArduinoSerialInterface.h>
ArduinoSerialInterface serial_interface;
#endif
#else
#error "need to define a serial interface"
#endif
@ -107,7 +117,6 @@ void halt() {
void setup() {
Serial.begin(115200);
board.begin();
#ifdef DISPLAY_CLASS
@ -152,6 +161,23 @@ void setup() {
#ifdef BLE_PIN_CODE
serial_interface.begin(BLE_NAME_PREFIX, the_mesh.getNodePrefs()->node_name, the_mesh.getBLEPin());
#elif ETH_ENABLED
Serial.print("Waiting for serial to connect...\n");
time_t timeout = millis();
// Initialize Serial for debug output.
while (!Serial)
{
if ((millis() - timeout) < 5000) { delay(100); } else { break; }
}
Serial.print("Initalizing ethernet adapter....\n");
bool result = serial_interface.begin();
if (!result) {
while (true)
{
delay(1); // Do nothing, just love you.
}
}
#else
serial_interface.begin(Serial);
#endif
@ -225,4 +251,14 @@ void loop() {
ui_task.loop();
#endif
rtc_clock.tick();
// Debugging only... making sure something is alive.
tick_count++;
if (tick_count % 5000 == 0) {
Serial.print(".");
}
#ifdef ETH_ENABLED
serial_interface.maintain();
#endif
}

167
examples/simple_repeater/main.cpp
View file

@ -8,6 +8,123 @@
static UITask ui_task(display);
#endif
#ifdef ETH_ENABLED
#include <SPI.h>
#include <RAK13800_W5100S.h>
#define PIN_SPI1_MISO (29)
#define PIN_SPI1_MOSI (30)
#define PIN_SPI1_SCK (3)
SPIClass ETH_SPI_PORT(NRF_SPIM1, PIN_SPI1_MISO, PIN_SPI1_SCK, PIN_SPI1_MOSI);
#define PIN_ETH_POWER_EN WB_IO2
#define PIN_ETHERNET_RESET 21
#define PIN_ETHERNET_SS 26
#ifndef ETH_TCP_PORT
#define ETH_TCP_PORT 23 // telnet port for CLI access
#endif
#define ETH_RETRY_INTERVAL_MS 30000
static EthernetServer eth_server(ETH_TCP_PORT);
static EthernetClient eth_client;
static volatile bool eth_running = false;
static void generateDeviceMac(uint8_t mac[6]) {
uint32_t device_id = NRF_FICR->DEVICEID[0];
mac[0] = 0x02; mac[1] = 0x92; mac[2] = 0x1F;
mac[3] = (device_id >> 16) & 0xFF;
mac[4] = (device_id >> 8) & 0xFF;
mac[5] = device_id & 0xFF;
}
// FreeRTOS task: handles hw init, DHCP, and retries in the background
static void eth_task(void* param) {
(void)param;
// Hardware init
Serial.println("ETH: Initializing hardware");
pinMode(PIN_ETH_POWER_EN, OUTPUT);
digitalWrite(PIN_ETH_POWER_EN, HIGH);
vTaskDelay(pdMS_TO_TICKS(100));
pinMode(PIN_ETHERNET_RESET, OUTPUT);
digitalWrite(PIN_ETHERNET_RESET, LOW);
vTaskDelay(pdMS_TO_TICKS(100));
digitalWrite(PIN_ETHERNET_RESET, HIGH);
ETH_SPI_PORT.begin();
Ethernet.init(ETH_SPI_PORT, PIN_ETHERNET_SS);
uint8_t mac[6];
generateDeviceMac(mac);
Serial.printf("ETH: MAC: %02X:%02X:%02X:%02X:%02X:%02X\n",
mac[0], mac[1], mac[2], mac[3], mac[4], mac[5]);
// Retry loop: keep trying until we get an IP
while (!eth_running) {
if (Ethernet.hardwareStatus() == EthernetNoHardware) {
Serial.println("ETH: Hardware not found, giving up");
vTaskDelete(NULL);
return;
}
if (Ethernet.linkStatus() == LinkOFF) {
vTaskDelay(pdMS_TO_TICKS(ETH_RETRY_INTERVAL_MS));
continue;
}
Serial.println("ETH: Link detected, attempting DHCP...");
if (Ethernet.begin(mac, 10000, 2000) == 0) {
Serial.println("ETH: DHCP failed, will retry");
vTaskDelay(pdMS_TO_TICKS(ETH_RETRY_INTERVAL_MS));
continue;
}
IPAddress ip = Ethernet.localIP();
Serial.printf("ETH: IP: %u.%u.%u.%u\n", ip[0], ip[1], ip[2], ip[3]);
Serial.printf("ETH: Listening on TCP port %d\n", ETH_TCP_PORT);
eth_server.begin();
eth_running = true;
}
// DHCP succeeded, task is done
vTaskDelete(NULL);
}
static void eth_start_task() {
xTaskCreate(eth_task, "eth_init", 1024, NULL, 1, NULL);
}
// Format ethernet status into reply buffer. Returns true if command was handled.
static bool eth_handle_command(const char* command, char* reply) {
if (strcmp(command, "eth") != 0) return false;
if (!eth_running) {
strcpy(reply, "ETH: not connected");
} else {
IPAddress ip = Ethernet.localIP();
sprintf(reply, "ETH: %u.%u.%u.%u:%d", ip[0], ip[1], ip[2], ip[3], ETH_TCP_PORT);
}
return true;
}
// Check for new TCP client connections
static void eth_check_client() {
if (eth_client && eth_client.connected()) return;
auto newClient = eth_server.available();
if (newClient) {
if (eth_client) eth_client.stop();
eth_client = newClient;
IPAddress ip = eth_client.remoteIP();
Serial.printf("ETH: Client connected from %u.%u.%u.%u\n", ip[0], ip[1], ip[2], ip[3]);
eth_client.println("MeshCore Repeater CLI");
eth_client.print("> ");
}
}
#endif
StdRNG fast_rng;
SimpleMeshTables tables;
@ -18,6 +135,9 @@ void halt() {
}
static char command[160];
#ifdef ETH_ENABLED
static char eth_command[160];
#endif
// For power saving
unsigned long lastActive = 0; // mark last active time
@ -85,6 +205,9 @@ void setup() {
mesh::Utils::printHex(Serial, the_mesh.self_id.pub_key, PUB_KEY_SIZE); Serial.println();
command[0] = 0;
#ifdef ETH_ENABLED
eth_command[0] = 0;
#endif
sensors.begin();
@ -94,6 +217,10 @@ void setup() {
ui_task.begin(the_mesh.getNodePrefs(), FIRMWARE_BUILD_DATE, FIRMWARE_VERSION);
#endif
#ifdef ETH_ENABLED
eth_start_task();
#endif
// send out initial zero hop Advertisement to the mesh
#if ENABLE_ADVERT_ON_BOOT == 1
the_mesh.sendSelfAdvertisement(16000, false);
@ -101,6 +228,7 @@ void setup() {
}
void loop() {
// Handle Serial CLI
int len = strlen(command);
while (Serial.available() && len < sizeof(command)-1) {
char c = Serial.read();
@ -119,6 +247,10 @@ void loop() {
Serial.print('\n');
command[len - 1] = 0; // replace newline with C string null terminator
char reply[160];
reply[0] = 0;
#ifdef ETH_ENABLED
if (!eth_handle_command(command, reply))
#endif
the_mesh.handleCommand(0, command, reply); // NOTE: there is no sender_timestamp via serial!
if (reply[0]) {
Serial.print(" -> "); Serial.println(reply);
@ -127,6 +259,41 @@ void loop() {
command[0] = 0; // reset command buffer
}
#ifdef ETH_ENABLED
if (eth_running) {
eth_check_client();
Ethernet.maintain();
}
if (eth_running && eth_client && eth_client.connected()) {
int elen = strlen(eth_command);
while (eth_client.available() && elen < (int)sizeof(eth_command)-1) {
char c = eth_client.read();
if (c == '\n') continue; // ignore LF
eth_command[elen++] = c;
eth_command[elen] = 0;
if (c == '\r') break;
}
if (elen == sizeof(eth_command)-1) {
eth_command[sizeof(eth_command)-1] = '\r';
}
if (elen > 0 && eth_command[elen - 1] == '\r') {
eth_command[elen - 1] = 0;
eth_client.println();
char reply[160];
reply[0] = 0;
if (!eth_handle_command(eth_command, reply))
the_mesh.handleCommand(0, eth_command, reply);
if (reply[0]) {
eth_client.print(" -> "); eth_client.println(reply);
}
eth_client.print("> ");
eth_command[0] = 0;
}
}
#endif
the_mesh.loop();
sensors.loop();
#ifdef DISPLAY_CLASS

157
examples/simple_room_server/main.cpp
View file

@ -3,6 +3,114 @@
#include "MyMesh.h"
#ifdef ETH_ENABLED
#include <SPI.h>
#include <RAK13800_W5100S.h>
#define PIN_SPI1_MISO (29)
#define PIN_SPI1_MOSI (30)
#define PIN_SPI1_SCK (3)
SPIClass ETH_SPI_PORT(NRF_SPIM1, PIN_SPI1_MISO, PIN_SPI1_SCK, PIN_SPI1_MOSI);
#define PIN_ETH_POWER_EN WB_IO2
#define PIN_ETHERNET_RESET 21
#define PIN_ETHERNET_SS 26
#ifndef ETH_TCP_PORT
#define ETH_TCP_PORT 23
#endif
#define ETH_RETRY_INTERVAL_MS 30000
static EthernetServer eth_server(ETH_TCP_PORT);
static EthernetClient eth_client;
static volatile bool eth_running = false;
static void generateDeviceMac(uint8_t mac[6]) {
uint32_t device_id = NRF_FICR->DEVICEID[0];
mac[0] = 0x02; mac[1] = 0x92; mac[2] = 0x1F;
mac[3] = (device_id >> 16) & 0xFF;
mac[4] = (device_id >> 8) & 0xFF;
mac[5] = device_id & 0xFF;
}
static void eth_task(void* param) {
(void)param;
Serial.println("ETH: Initializing hardware");
pinMode(PIN_ETH_POWER_EN, OUTPUT);
digitalWrite(PIN_ETH_POWER_EN, HIGH);
vTaskDelay(pdMS_TO_TICKS(100));
pinMode(PIN_ETHERNET_RESET, OUTPUT);
digitalWrite(PIN_ETHERNET_RESET, LOW);
vTaskDelay(pdMS_TO_TICKS(100));
digitalWrite(PIN_ETHERNET_RESET, HIGH);
ETH_SPI_PORT.begin();
Ethernet.init(ETH_SPI_PORT, PIN_ETHERNET_SS);
uint8_t mac[6];
generateDeviceMac(mac);
Serial.printf("ETH: MAC: %02X:%02X:%02X:%02X:%02X:%02X\n",
mac[0], mac[1], mac[2], mac[3], mac[4], mac[5]);
while (!eth_running) {
if (Ethernet.hardwareStatus() == EthernetNoHardware) {
Serial.println("ETH: Hardware not found, giving up");
vTaskDelete(NULL);
return;
}
if (Ethernet.linkStatus() == LinkOFF) {
vTaskDelay(pdMS_TO_TICKS(ETH_RETRY_INTERVAL_MS));
continue;
}
Serial.println("ETH: Link detected, attempting DHCP...");
if (Ethernet.begin(mac, 10000, 2000) == 0) {
Serial.println("ETH: DHCP failed, will retry");
vTaskDelay(pdMS_TO_TICKS(ETH_RETRY_INTERVAL_MS));
continue;
}
IPAddress ip = Ethernet.localIP();
Serial.printf("ETH: IP: %u.%u.%u.%u\n", ip[0], ip[1], ip[2], ip[3]);
Serial.printf("ETH: Listening on TCP port %d\n", ETH_TCP_PORT);
eth_server.begin();
eth_running = true;
}
vTaskDelete(NULL);
}
static void eth_start_task() {
xTaskCreate(eth_task, "eth_init", 1024, NULL, 1, NULL);
}
static bool eth_handle_command(const char* command, char* reply) {
if (strcmp(command, "eth") != 0) return false;
if (!eth_running) {
strcpy(reply, "ETH: not connected");
} else {
IPAddress ip = Ethernet.localIP();
sprintf(reply, "ETH: %u.%u.%u.%u:%d", ip[0], ip[1], ip[2], ip[3], ETH_TCP_PORT);
}
return true;
}
static void eth_check_client() {
if (eth_client && eth_client.connected()) return;
auto newClient = eth_server.available();
if (newClient) {
if (eth_client) eth_client.stop();
eth_client = newClient;
IPAddress ip = eth_client.remoteIP();
Serial.printf("ETH: Client connected from %u.%u.%u.%u\n", ip[0], ip[1], ip[2], ip[3]);
eth_client.println("MeshCore Room Server CLI");
eth_client.print("> ");
}
}
#endif
#ifdef DISPLAY_CLASS
#include "UITask.h"
static UITask ui_task(display);
@ -17,6 +125,9 @@ void halt() {
}
static char command[MAX_POST_TEXT_LEN+1];
#ifdef ETH_ENABLED
static char eth_command[MAX_POST_TEXT_LEN+1];
#endif
void setup() {
Serial.begin(115200);
@ -67,6 +178,9 @@ void setup() {
mesh::Utils::printHex(Serial, the_mesh.self_id.pub_key, PUB_KEY_SIZE); Serial.println();
command[0] = 0;
#ifdef ETH_ENABLED
eth_command[0] = 0;
#endif
sensors.begin();
@ -76,6 +190,10 @@ void setup() {
ui_task.begin(the_mesh.getNodePrefs(), FIRMWARE_BUILD_DATE, FIRMWARE_VERSION);
#endif
#ifdef ETH_ENABLED
eth_start_task();
#endif
// send out initial zero hop Advertisement to the mesh
#if ENABLE_ADVERT_ON_BOOT == 1
the_mesh.sendSelfAdvertisement(16000, false);
@ -99,6 +217,10 @@ void loop() {
if (len > 0 && command[len - 1] == '\r') { // received complete line
command[len - 1] = 0; // replace newline with C string null terminator
char reply[160];
reply[0] = 0;
#ifdef ETH_ENABLED
if (!eth_handle_command(command, reply))
#endif
the_mesh.handleCommand(0, command, reply); // NOTE: there is no sender_timestamp via serial!
if (reply[0]) {
Serial.print(" -> "); Serial.println(reply);
@ -107,6 +229,41 @@ void loop() {
command[0] = 0; // reset command buffer
}
#ifdef ETH_ENABLED
if (eth_running) {
eth_check_client();
Ethernet.maintain();
}
if (eth_running && eth_client && eth_client.connected()) {
int elen = strlen(eth_command);
while (eth_client.available() && elen < (int)sizeof(eth_command)-1) {
char c = eth_client.read();
if (c == '\n') continue;
eth_command[elen++] = c;
eth_command[elen] = 0;
if (c == '\r') break;
}
if (elen == sizeof(eth_command)-1) {
eth_command[sizeof(eth_command)-1] = '\r';
}
if (elen > 0 && eth_command[elen - 1] == '\r') {
eth_command[elen - 1] = 0;
eth_client.println();
char reply[160];
reply[0] = 0;
if (!eth_handle_command(eth_command, reply))
the_mesh.handleCommand(0, eth_command, reply);
if (reply[0]) {
eth_client.print(" -> "); eth_client.println(reply);
}
eth_client.print("> ");
eth_command[0] = 0;
}
}
#endif
the_mesh.loop();
sensors.loop();
#ifdef DISPLAY_CLASS

303
src/helpers/nrf52/SerialEthernetInterface.cpp Normal file
View file

@ -0,0 +1,303 @@
#include "SerialEthernetInterface.h"
#include <SPI.h>
#include <EthernetUdp.h>
#define PIN_SPI1_MISO (29) // (0 + 29)
#define PIN_SPI1_MOSI (30) // (0 + 30)
#define PIN_SPI1_SCK (3) // (0 + 3)
SPIClass ETH_SPI_PORT(NRF_SPIM1, PIN_SPI1_MISO, PIN_SPI1_SCK, PIN_SPI1_MOSI);
#define PIN_ETH_POWER_EN WB_IO2 // output, high to enable
#define PIN_ETHERNET_RESET 21
#define PIN_ETHERNET_SS 26
//#define STATIC_IP 1
#define RECV_STATE_IDLE 0
#define RECV_STATE_HDR_FOUND 1
#define RECV_STATE_LEN1_FOUND 2
#define RECV_STATE_LEN2_FOUND 3
bool SerialEthernetInterface::begin() {
ETH_DEBUG_PRINTLN("Ethernet initalizing");
#ifdef PIN_ETH_POWER_EN
ETH_DEBUG_PRINTLN("Ethernet power enable");
pinMode(PIN_ETH_POWER_EN, OUTPUT);
digitalWrite(PIN_ETH_POWER_EN, HIGH); // Power up.
delay(100);
ETH_DEBUG_PRINTLN("Ethernet power enabled");
#endif
#ifdef PIN_ETHERNET_RESET
pinMode(PIN_ETHERNET_RESET, OUTPUT);
digitalWrite(PIN_ETHERNET_RESET, LOW); // Reset Time.
delay(100);
digitalWrite(PIN_ETHERNET_RESET, HIGH); // Reset Time.
ETH_DEBUG_PRINTLN("Ethernet reset pulse");
#endif
uint8_t mac[6];
generateDeviceMac(mac);
ETH_DEBUG_PRINTLN(
"Ethernet MAC: %02X:%02X:%02X:%02X:%02X:%02X",
mac[0],
mac[1],
mac[2],
mac[3],
mac[4],
mac[5]);
ETH_DEBUG_PRINTLN("Init");
ETH_SPI_PORT.begin();
Ethernet.init(ETH_SPI_PORT, PIN_ETHERNET_SS);
// Hardcode IP address for now
#ifdef STATIC_IP
IPAddress ip(192, 168, 8, 118);
IPAddress gateway(192, 168, 8, 1);
IPAddress subnet(255, 255, 255, 0);
IPAddress dns(192, 168, 8, 1);
Ethernet.begin(mac, ip, dns, gateway, subnet);
#else
ETH_DEBUG_PRINTLN("Begin");
if (Ethernet.begin(mac) == 0) {
ETH_DEBUG_PRINTLN("Begin failed.");
// DHCP failed -- let's figure out why
if (Ethernet.hardwareStatus() == EthernetNoHardware) // Check for Ethernet hardware present.
{
ETH_DEBUG_PRINTLN("Ethernet hardware not found.");
return false;
}
if (Ethernet.linkStatus() == LinkOFF) // No physical connection
{
ETH_DEBUG_PRINTLN("Ethernet cable not connected.");
return false;
}
ETH_DEBUG_PRINTLN("Ethernet: DHCP failed for unknown reason.");
return false;
}
#endif
ETH_DEBUG_PRINTLN("Ethernet begin complete");
IPAddress ip = Ethernet.localIP();
ETH_DEBUG_PRINT_IP("IP", ip);
IPAddress subnet = Ethernet.subnetMask();
ETH_DEBUG_PRINT_IP("Subnet", subnet);
IPAddress gateway = Ethernet.gatewayIP();
ETH_DEBUG_PRINT_IP("Gateway", gateway);
server.begin(); // start listening for clients
ETH_DEBUG_PRINTLN("Ethernet: listening on TCP port: %d", TCP_PORT);
return true;
}
void SerialEthernetInterface::enable() {
if (_isEnabled) return;
_isEnabled = true;
clearBuffers();
}
void SerialEthernetInterface::disable() {
_isEnabled = false;
}
size_t SerialEthernetInterface::writeFrame(const uint8_t src[], size_t len) {
if (len > MAX_FRAME_SIZE) {
ETH_DEBUG_PRINTLN("writeFrame(), frame too big, len=%d\n", len);
return 0;
}
if (deviceConnected && len > 0) {
if (send_queue_len >= FRAME_QUEUE_SIZE) {
ETH_DEBUG_PRINTLN("writeFrame(), send_queue is full!");
return 0;
}
send_queue[send_queue_len].len = len; // add to send queue
memcpy(send_queue[send_queue_len].buf, src, len);
send_queue_len++;
return len;
}
return 0;
}
bool SerialEthernetInterface::isWriteBusy() const {
return false;
}
size_t SerialEthernetInterface::checkRecvFrame(uint8_t dest[]) {
// check if new client connected
if (client && client.connected()) {
// Avoid polling for new clients while an active connection exists.
} else {
auto newClient = server.available();
if (newClient) {
IPAddress new_ip = newClient.remoteIP();
uint16_t new_port = newClient.remotePort();
ETH_DEBUG_PRINTLN(
"New client available %u.%u.%u.%u:%u",
new_ip[0],
new_ip[1],
new_ip[2],
new_ip[3],
new_port);
if (client && client.connected()) {
IPAddress cur_ip = client.remoteIP();
uint16_t cur_port = client.remotePort();
ETH_DEBUG_PRINTLN(
"Current client %u.%u.%u.%u:%u",
cur_ip[0],
cur_ip[1],
cur_ip[2],
cur_ip[3],
cur_port);
if (cur_ip == new_ip && cur_port == new_port) {
ETH_DEBUG_PRINTLN("Ignoring duplicate client");
return 0;
}
}
deviceConnected = false;
if (client) {
ETH_DEBUG_PRINTLN("Closing previous client");
client.stop();
}
_state = RECV_STATE_IDLE;
_frame_len = 0;
_rx_len = 0;
client = newClient;
ETH_DEBUG_PRINTLN("Switched to new client");
}
}
if (client.connected()) {
if (!deviceConnected) {
ETH_DEBUG_PRINTLN(
"Got connection %u.%u.%u.%u:%u",
client.remoteIP()[0],
client.remoteIP()[1],
client.remoteIP()[2],
client.remoteIP()[3],
client.remotePort());
deviceConnected = true;
}
} else {
if (deviceConnected) {
deviceConnected = false;
ETH_DEBUG_PRINTLN("Disconnected");
}
}
if (deviceConnected) {
if (send_queue_len > 0) { // first, check send queue
_last_write = millis();
int len = send_queue[0].len;
#if ETH_RAW_LINE
ETH_DEBUG_PRINTLN("TX line len=%d", len);
client.write(send_queue[0].buf, len);
client.write("\r\n", 2);
#else
uint8_t pkt[3+len]; // use same header as serial interface so client can delimit frames
pkt[0] = '>';
pkt[1] = (len & 0xFF); // LSB
pkt[2] = (len >> 8); // MSB
memcpy(&pkt[3], send_queue[0].buf, send_queue[0].len);
ETH_DEBUG_PRINTLN("Sending frame len=%d", len);
#if ETH_DEBUG_LOGGING && ARDUINO
ETH_DEBUG_PRINTLN("TX frame len=%d", len);
#endif
client.write(pkt, 3 + len);
#endif
send_queue_len--;
for (int i = 0; i < send_queue_len; i++) { // delete top item from queue
send_queue[i] = send_queue[i + 1];
}
} else {
while (client.available()) {
int c = client.read();
if (c < 0) break;
#if ETH_RAW_LINE
if (c == '\r' || c == '\n') {
if (_rx_len == 0) {
continue;
}
uint16_t out_len = _rx_len;
if (out_len > MAX_FRAME_SIZE) {
out_len = MAX_FRAME_SIZE;
}
memcpy(dest, _rx_buf, out_len);
_rx_len = 0;
return out_len;
}
if (_rx_len < MAX_FRAME_SIZE) {
_rx_buf[_rx_len] = (uint8_t)c;
_rx_len++;
}
#else
switch (_state) {
case RECV_STATE_IDLE:
if (c == '<') {
_state = RECV_STATE_HDR_FOUND;
}
break;
case RECV_STATE_HDR_FOUND:
_frame_len = (uint8_t)c;
_state = RECV_STATE_LEN1_FOUND;
break;
case RECV_STATE_LEN1_FOUND:
_frame_len |= ((uint16_t)c) << 8;
_rx_len = 0;
_state = _frame_len > 0 ? RECV_STATE_LEN2_FOUND : RECV_STATE_IDLE;
break;
default:
if (_rx_len < MAX_FRAME_SIZE) {
_rx_buf[_rx_len] = (uint8_t)c;
}
_rx_len++;
if (_rx_len >= _frame_len) {
if (_frame_len > MAX_FRAME_SIZE) {
_frame_len = MAX_FRAME_SIZE;
}
#if ETH_DEBUG_LOGGING && ARDUINO
ETH_DEBUG_PRINTLN("RX frame len=%d", _frame_len);
#endif
memcpy(dest, _rx_buf, _frame_len);
_state = RECV_STATE_IDLE;
return _frame_len;
}
}
#endif
}
}
}
return 0;
}
bool SerialEthernetInterface::isConnected() const {
return deviceConnected; //pServer != NULL && pServer->getConnectedCount() > 0;
}
void SerialEthernetInterface::generateDeviceMac(uint8_t mac[6]) {
uint32_t device_id = NRF_FICR->DEVICEID[0];
mac[0] = 0x02;
mac[1] = 0x92;
mac[2] = 0x1F;
mac[3] = (device_id >> 16) & 0xFF;
mac[4] = (device_id >> 8) & 0xFF;
mac[5] = device_id & 0xFF;
}
void SerialEthernetInterface::maintain() {
Ethernet.maintain();
}

83
src/helpers/nrf52/SerialEthernetInterface.h Normal file
View file

@ -0,0 +1,83 @@
#include "helpers/BaseSerialInterface.h"
#include <SPI.h>
#include <RAK13800_W5100S.h>
// expects ETH_ENABLED = 1
#define TCP_PORT 5000
// define ETH_RAW_LINE=1 to use raw line-based CLI instead of framed packets
class SerialEthernetInterface : public BaseSerialInterface {
bool deviceConnected;
bool _isEnabled;
unsigned long _last_write;
unsigned long adv_restart_time;
uint8_t _state;
uint16_t _frame_len;
uint16_t _rx_len;
uint8_t _rx_buf[MAX_FRAME_SIZE];
EthernetServer server;
EthernetClient client;
struct Frame {
uint8_t len;
uint8_t buf[MAX_FRAME_SIZE];
};
#define FRAME_QUEUE_SIZE 4
int recv_queue_len;
Frame recv_queue[FRAME_QUEUE_SIZE];
int send_queue_len;
Frame send_queue[FRAME_QUEUE_SIZE];
void clearBuffers() {
recv_queue_len = 0;
send_queue_len = 0;
_state = 0;
_frame_len = 0;
_rx_len = 0;
}
protected:
public:
SerialEthernetInterface() : server(EthernetServer(TCP_PORT)) {
deviceConnected = false;
_isEnabled = false;
_last_write = 0;
send_queue_len = recv_queue_len = 0;
_state = 0;
_frame_len = 0;
_rx_len = 0;
}
bool begin();
// BaseSerialInterface methods
void enable() override;
void disable() override;
bool isEnabled() const override { return _isEnabled; }
bool isConnected() const override;
bool isWriteBusy() const override;
size_t writeFrame(const uint8_t src[], size_t len) override;
size_t checkRecvFrame(uint8_t dest[]) override;
void maintain();
private:
void generateDeviceMac(uint8_t mac[6]);
};
#if ETH_DEBUG_LOGGING && ARDUINO
#include <Arduino.h>
#define ETH_DEBUG_PRINT(F, ...) Serial.printf("ETH: " F, ##__VA_ARGS__)
#define ETH_DEBUG_PRINTLN(F, ...) Serial.printf("ETH: " F "\n", ##__VA_ARGS__)
#define ETH_DEBUG_PRINT_IP(name, ip) Serial.printf(name ": %u.%u.%u.%u" "\n", ip[0], ip[1], ip[2], ip[3])
#else
#define ETH_DEBUG_PRINT(...) {}
#define ETH_DEBUG_PRINTLN(...) {}
#define ETH_DEBUG_PRINT_IP(...) {}
#endif

7
src/helpers/sensors/EnvironmentSensorManager.cpp
View file

@ -628,6 +628,13 @@ void EnvironmentSensorManager::rakGPSInit(){
bool EnvironmentSensorManager::gpsIsAwake(uint8_t ioPin){
#if defined(ETH_ENABLED) && defined(RAK_BOARD)
if (ioPin == WB_IO2) {
// WB_IO2 powers the Ethernet module on RAK baseboards.
return false;
}
#endif
//set initial waking state
pinMode(ioPin,OUTPUT);
digitalWrite(ioPin,LOW);

4
variants/rak4631/RAK4631Board.cpp
View file

@ -36,6 +36,10 @@ void RAK4631Board::begin() {
pinMode(PIN_USER_BTN_ANA, INPUT_PULLUP);
#endif
#ifdef RAK_ETH_ENABLE
beginETH();
#endif
#if defined(PIN_BOARD_SDA) && defined(PIN_BOARD_SCL)
Wire.setPins(PIN_BOARD_SDA, PIN_BOARD_SCL);
#endif

73
variants/rak4631/platformio.ini
View file

@ -46,6 +46,26 @@ build_src_filter = ${rak4631.build_src_filter}
+<helpers/ui/SSD1306Display.cpp>
+<../examples/simple_repeater>
[env:RAK_4631_repeater_eth]
extends = rak4631
build_flags =
${rak4631.build_flags}
-D DISPLAY_CLASS=SSD1306Display
-D ADVERT_NAME='"RAK4631 Repeater ETH"'
-D ADVERT_LAT=0.0
-D ADVERT_LON=0.0
-D ADMIN_PASSWORD='"password"'
-D MAX_NEIGHBOURS=50
-D ETH_ENABLED=1
-D MESH_DEBUG=1
build_src_filter = ${rak4631.build_src_filter}
+<helpers/ui/SSD1306Display.cpp>
+<../examples/simple_repeater>
lib_deps =
${rak4631.lib_deps}
# renovate: datasource=github-tags depName=RAK13800-W5100S packageName=RAKWireless/RAK13800-W5100S
https://github.com/RAKWireless/RAK13800-W5100S/archive/1.0.2.zip
[env:RAK_4631_repeater_bridge_rs232_serial1]
extends = rak4631
build_flags =
@ -108,6 +128,26 @@ build_src_filter = ${rak4631.build_src_filter}
+<helpers/ui/SSD1306Display.cpp>
+<../examples/simple_room_server>
[env:RAK_4631_room_server_eth]
extends = rak4631
build_flags =
${rak4631.build_flags}
-D DISPLAY_CLASS=SSD1306Display
-D ADVERT_NAME='"Test Room ETH"'
-D ADVERT_LAT=0.0
-D ADVERT_LON=0.0
-D ADMIN_PASSWORD='"password"'
-D ROOM_PASSWORD='"hello"'
-D ETH_ENABLED=1
-D MESH_DEBUG=1
build_src_filter = ${rak4631.build_src_filter}
+<helpers/ui/SSD1306Display.cpp>
+<../examples/simple_room_server>
lib_deps =
${rak4631.lib_deps}
# renovate: datasource=github-tags depName=RAK13800-W5100S packageName=RAKWireless/RAK13800-W5100S
https://github.com/RAKWireless/RAK13800-W5100S/archive/1.0.2.zip
[env:RAK_4631_companion_radio_usb]
extends = rak4631
board_build.ldscript = boards/nrf52840_s140_v6_extrafs.ld
@ -129,6 +169,37 @@ lib_deps =
${rak4631.lib_deps}
densaugeo/base64 @ ~1.4.0
[env:RAK_4631_companion_radio_eth]
extends = rak4631
board_build.ldscript = boards/nrf52840_s140_v6.ld
board_upload.maximum_size = 712704
build_unflags =
-D EXTRAFS=1
build_flags =
${rak4631.build_flags}
-I examples/companion_radio/ui-new
-D PIN_USER_BTN=9
-D PIN_USER_BTN_ANA=31
-D DISPLAY_CLASS=SSD1306Display
-D MAX_CONTACTS=350
-D MAX_GROUP_CHANNELS=40
-D ETH_ENABLED=1
; NOTE: DO NOT ENABLE --> -D MESH_PACKET_LOGGING=1
; NOTE: DO NOT ENABLE --> -D MESH_DEBUG=1
-D MESH_DEBUG=1
-D ETH_DEBUG_LOGGING=1
build_src_filter = ${rak4631.build_src_filter}
+<../examples/companion_radio/*.cpp>
+<../examples/companion_radio/ui-new/*.cpp>
+<helpers/nrf52/SerialEthernetInterface.cpp>
lib_deps =
${rak4631.lib_deps}
densaugeo/base64 @ ~1.4.0
# renovate: datasource=github-tags depName=RAK13800-W5100S packageName=RAKWireless/RAK13800-W5100S
https://github.com/RAKWireless/RAK13800-W5100S/archive/1.0.2.zip
[env:RAK_4631_companion_radio_ble]
extends = rak4631
board_build.ldscript = boards/nrf52840_s140_v6_extrafs.ld
@ -192,4 +263,4 @@ build_flags =
build_src_filter = ${rak4631.build_src_filter}
+<../examples/kiss_modem/>
lib_deps =
${rak4631.lib_deps}
${rak4631.lib_deps}