Updates based on PR review feedback from liamcottle

This commit is contained in:
Ryan Gregg
2026-03-10 22:35:31 -07:00
parent ffe0853d7f
commit 3e9ceba24a
9 changed files with 237 additions and 249 deletions
+13
View File
@@ -0,0 +1,13 @@
#pragma once
#include <Arduino.h>
static inline 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;
}
+53 -64
View File
@@ -1,4 +1,5 @@
#include "SerialEthernetInterface.h"
#include "EthernetMac.h"
#include <SPI.h>
#include <EthernetUdp.h>
@@ -6,12 +7,11 @@
#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);
SPIClass ETHERNET_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_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
@@ -19,15 +19,15 @@ SPIClass ETH_SPI_PORT(NRF_SPIM1, PIN_SPI1_MISO, PIN_SPI1_SCK, PIN_SPI1_MOSI);
#define RECV_STATE_LEN2_FOUND 3
bool SerialEthernetInterface::begin() {
ETH_DEBUG_PRINTLN("Ethernet initializing");
#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.
ETHERNET_DEBUG_PRINTLN("Ethernet initializing");
#ifdef PIN_ETHERNET_POWER_EN
ETHERNET_DEBUG_PRINTLN("Ethernet power enable");
pinMode(PIN_ETHERNET_POWER_EN, OUTPUT);
digitalWrite(PIN_ETHERNET_POWER_EN, HIGH); // Power up.
delay(100);
ETH_DEBUG_PRINTLN("Ethernet power enabled");
ETHERNET_DEBUG_PRINTLN("Ethernet power enabled");
#endif
#ifdef PIN_ETHERNET_RESET
@@ -35,12 +35,12 @@ bool SerialEthernetInterface::begin() {
digitalWrite(PIN_ETHERNET_RESET, LOW); // Reset Time.
delay(100);
digitalWrite(PIN_ETHERNET_RESET, HIGH); // Reset Time.
ETH_DEBUG_PRINTLN("Ethernet reset pulse");
ETHERNET_DEBUG_PRINTLN("Ethernet reset pulse");
#endif
uint8_t mac[6];
generateDeviceMac(mac);
ETH_DEBUG_PRINTLN(
ETHERNET_DEBUG_PRINTLN(
"Ethernet MAC: %02X:%02X:%02X:%02X:%02X:%02X",
mac[0],
mac[1],
@@ -48,49 +48,49 @@ bool SerialEthernetInterface::begin() {
mac[3],
mac[4],
mac[5]);
ETH_DEBUG_PRINTLN("Init");
ETH_SPI_PORT.begin();
Ethernet.init(ETH_SPI_PORT, PIN_ETHERNET_SS);
ETHERNET_DEBUG_PRINTLN("Init");
ETHERNET_SPI_PORT.begin();
Ethernet.init(ETHERNET_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);
// Use static IP if build flags are defined, otherwise DHCP
#if defined(ETHERNET_STATIC_IP) && defined(ETHERNET_STATIC_GATEWAY) && defined(ETHERNET_STATIC_SUBNET) && defined(ETHERNET_STATIC_DNS)
IPAddress ip(ETHERNET_STATIC_IP);
IPAddress gateway(ETHERNET_STATIC_GATEWAY);
IPAddress subnet(ETHERNET_STATIC_SUBNET);
IPAddress dns(ETHERNET_STATIC_DNS);
Ethernet.begin(mac, ip, dns, gateway, subnet);
#else
ETH_DEBUG_PRINTLN("Begin");
ETHERNET_DEBUG_PRINTLN("Begin");
if (Ethernet.begin(mac) == 0) {
ETH_DEBUG_PRINTLN("Begin failed.");
ETHERNET_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.");
ETHERNET_DEBUG_PRINTLN("Ethernet hardware not found.");
return false;
}
if (Ethernet.linkStatus() == LinkOFF) // No physical connection
{
ETH_DEBUG_PRINTLN("Ethernet cable not connected.");
ETHERNET_DEBUG_PRINTLN("Ethernet cable not connected.");
return false;
}
ETH_DEBUG_PRINTLN("Ethernet: DHCP failed for unknown reason.");
ETHERNET_DEBUG_PRINTLN("Ethernet: DHCP failed for unknown reason.");
return false;
}
#endif
ETH_DEBUG_PRINTLN("Ethernet begin complete");
ETHERNET_DEBUG_PRINTLN("Ethernet begin complete");
IPAddress ip = Ethernet.localIP();
ETH_DEBUG_PRINT_IP("IP", ip);
ETHERNET_DEBUG_PRINT_IP("IP", ip);
IPAddress subnet = Ethernet.subnetMask();
ETH_DEBUG_PRINT_IP("Subnet", subnet);
ETHERNET_DEBUG_PRINT_IP("Subnet", subnet);
IPAddress gateway = Ethernet.gatewayIP();
ETH_DEBUG_PRINT_IP("Gateway", gateway);
ETHERNET_DEBUG_PRINT_IP("Gateway", gateway);
server.begin(); // start listening for clients
ETH_DEBUG_PRINTLN("Ethernet: listening on TCP port: %d", ETH_TCP_PORT);
ETHERNET_DEBUG_PRINTLN("Ethernet: listening on TCP port: %d", ETHERNET_TCP_PORT);
return true;
}
@@ -108,13 +108,13 @@ void SerialEthernetInterface::disable() {
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);
ETHERNET_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!");
ETHERNET_DEBUG_PRINTLN("writeFrame(), send_queue is full!");
return 0;
}
@@ -140,7 +140,7 @@ size_t SerialEthernetInterface::checkRecvFrame(uint8_t dest[]) {
if (newClient) {
IPAddress new_ip = newClient.remoteIP();
uint16_t new_port = newClient.remotePort();
ETH_DEBUG_PRINTLN(
ETHERNET_DEBUG_PRINTLN(
"New client available %u.%u.%u.%u:%u",
new_ip[0],
new_ip[1],
@@ -150,7 +150,7 @@ size_t SerialEthernetInterface::checkRecvFrame(uint8_t dest[]) {
if (client && client.connected()) {
IPAddress cur_ip = client.remoteIP();
uint16_t cur_port = client.remotePort();
ETH_DEBUG_PRINTLN(
ETHERNET_DEBUG_PRINTLN(
"Current client %u.%u.%u.%u:%u",
cur_ip[0],
cur_ip[1],
@@ -158,27 +158,27 @@ size_t SerialEthernetInterface::checkRecvFrame(uint8_t dest[]) {
cur_ip[3],
cur_port);
if (cur_ip == new_ip && cur_port == new_port) {
ETH_DEBUG_PRINTLN("Ignoring duplicate client");
ETHERNET_DEBUG_PRINTLN("Ignoring duplicate client");
return 0;
}
}
deviceConnected = false;
if (client) {
ETH_DEBUG_PRINTLN("Closing previous client");
ETHERNET_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");
ETHERNET_DEBUG_PRINTLN("Switched to new client");
}
}
if (client.connected()) {
if (!deviceConnected) {
ETH_DEBUG_PRINTLN(
ETHERNET_DEBUG_PRINTLN(
"Got connection %u.%u.%u.%u:%u",
client.remoteIP()[0],
client.remoteIP()[1],
@@ -190,18 +190,18 @@ size_t SerialEthernetInterface::checkRecvFrame(uint8_t dest[]) {
} else {
if (deviceConnected) {
deviceConnected = false;
ETH_DEBUG_PRINTLN("Disconnected");
ETHERNET_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);
#if ETHERNET_RAW_LINE
ETHERNET_DEBUG_PRINTLN("TX line len=%d", len);
client.write(send_queue[0].buf, len);
client.write("\r\n", 2);
#else
@@ -210,9 +210,9 @@ size_t SerialEthernetInterface::checkRecvFrame(uint8_t dest[]) {
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);
ETHERNET_DEBUG_PRINTLN("Sending frame len=%d", len);
#if ETHERNET_DEBUG_LOGGING && ARDUINO
ETHERNET_DEBUG_PRINTLN("TX frame len=%d", len);
#endif
client.write(pkt, 3 + len);
#endif
@@ -225,7 +225,7 @@ size_t SerialEthernetInterface::checkRecvFrame(uint8_t dest[]) {
int c = client.read();
if (c < 0) break;
#if ETH_RAW_LINE
#if ETHERNET_RAW_LINE
if (c == '\r' || c == '\n') {
if (_rx_len == 0) {
continue;
@@ -267,8 +267,8 @@ size_t SerialEthernetInterface::checkRecvFrame(uint8_t dest[]) {
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);
#if ETHERNET_DEBUG_LOGGING && ARDUINO
ETHERNET_DEBUG_PRINTLN("RX frame len=%d", _frame_len);
#endif
memcpy(dest, _rx_buf, _frame_len);
_state = RECV_STATE_IDLE;
@@ -284,20 +284,9 @@ size_t SerialEthernetInterface::checkRecvFrame(uint8_t dest[]) {
}
bool SerialEthernetInterface::isConnected() const {
return deviceConnected; //pServer != NULL && pServer->getConnectedCount() > 0;
return deviceConnected;
}
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() {
void SerialEthernetInterface::loop() {
Ethernet.maintain();
}
+12 -15
View File
@@ -4,10 +4,10 @@
#include <SPI.h>
#include <RAK13800_W5100S.h>
#ifndef ETH_TCP_PORT
#define ETH_TCP_PORT 5000
#ifndef ETHERNET_TCP_PORT
#define ETHERNET_TCP_PORT 5000
#endif
// define ETH_RAW_LINE=1 to use raw line-based CLI instead of framed packets
// define ETHERNET_RAW_LINE=1 to use raw line-based CLI instead of framed packets
class SerialEthernetInterface : public BaseSerialInterface {
bool deviceConnected;
@@ -44,7 +44,7 @@ class SerialEthernetInterface : public BaseSerialInterface {
protected:
public:
SerialEthernetInterface() : server(EthernetServer(ETH_TCP_PORT)) {
SerialEthernetInterface() : server(EthernetServer(ETHERNET_TCP_PORT)) {
deviceConnected = false;
_isEnabled = false;
_last_write = 0;
@@ -66,20 +66,17 @@ class SerialEthernetInterface : public BaseSerialInterface {
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]);
void loop();
};
#if ETH_DEBUG_LOGGING && ARDUINO
#if ETHERNET_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])
#define ETHERNET_DEBUG_PRINT(F, ...) Serial.printf("ETH: " F, ##__VA_ARGS__)
#define ETHERNET_DEBUG_PRINTLN(F, ...) Serial.printf("ETH: " F "\n", ##__VA_ARGS__)
#define ETHERNET_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(...) {}
#define ETHERNET_DEBUG_PRINT(...) {}
#define ETHERNET_DEBUG_PRINTLN(...) {}
#define ETHERNET_DEBUG_PRINT_IP(...) {}
#endif
@@ -628,7 +628,7 @@ void EnvironmentSensorManager::rakGPSInit(){
bool EnvironmentSensorManager::gpsIsAwake(uint8_t ioPin){
#if defined(ETH_ENABLED) && defined(RAK_BOARD)
#if defined(ETHERNET_ENABLED) && defined(RAK_BOARD)
if (ioPin == WB_IO2) {
// WB_IO2 powers the Ethernet module on RAK baseboards.
return false;