From fa7ca3f4181942d4dc623db4d8336ec0a1b5f1e4 Mon Sep 17 00:00:00 2001 From: Florent Date: Tue, 3 Nov 2026 21:10:01 -0400 Subject: [PATCH] rak_gps: simplify the rak driver, which now only handles i2c, for nmea use nmea driver directly --- .../{RakGpsDriver.h => RakI2cGpsDriver.h} | 50 +++++--------- src/helpers/sensors/RakLocationProvider.h | 67 ++++++++++++------- variants/gat562_30s_mesh_kit/target.cpp | 2 +- variants/rak3401/target.cpp | 2 +- variants/rak4631/target.cpp | 2 +- 5 files changed, 61 insertions(+), 62 deletions(-) rename src/helpers/sensors/{RakGpsDriver.h => RakI2cGpsDriver.h} (65%) diff --git a/src/helpers/sensors/RakGpsDriver.h b/src/helpers/sensors/RakI2cGpsDriver.h similarity index 65% rename from src/helpers/sensors/RakGpsDriver.h rename to src/helpers/sensors/RakI2cGpsDriver.h index b37548528..ac76e0692 100644 --- a/src/helpers/sensors/RakGpsDriver.h +++ b/src/helpers/sensors/RakI2cGpsDriver.h @@ -1,16 +1,16 @@ #pragma once -#include "NmeaGpsDriver.h" +#include "GpsDriver.h" #include -class RakGpsDriver : public GpsDriver { - NmeaGpsDriver _serialDriver; +// Driver for the RAK12500 (u-blox, I2C). Serial NMEA modules are handled by NmeaGpsDriver. +class RakI2cGpsDriver : public GpsDriver { TwoWire& _wire; SFE_UBLOX_GNSS _gnss; uint8_t _powerPin = 0; - bool _usingRak12500 = false; bool _detected = false; + bool _started = false; bool probeRak12500(uint8_t powerPin) { #if defined(ETHERNET_ENABLED) && defined(RAK_BOARD) @@ -37,7 +37,6 @@ class RakGpsDriver : public GpsDriver { _gnss.setMeasurementRate(1000); _gnss.saveConfigSelective(VAL_CFG_SUBSEC_IOPORT); _powerPin = powerPin; - _usingRak12500 = true; return true; } @@ -48,62 +47,47 @@ class RakGpsDriver : public GpsDriver { } public: - RakGpsDriver(HardwareSerial& serial = Serial1, TwoWire& wire = Wire) - : _serialDriver(serial), _wire(wire) {} + RakI2cGpsDriver(TwoWire& wire = Wire) : _wire(wire) {} void begin() override { - if (_usingRak12500) { + if (!_detected) return; #ifndef RAK_3401 - pinMode(_powerPin, OUTPUT); - digitalWrite(_powerPin, HIGH); + pinMode(_powerPin, OUTPUT); + digitalWrite(_powerPin, HIGH); #endif - return; - } - _serialDriver.begin(); + _started = true; } - void reset() override { - if (!_usingRak12500) _serialDriver.reset(); - } + void reset() override {} void stop() override { - if (_usingRak12500) { + if (_detected) { #ifndef RAK_3401 pinMode(_powerPin, OUTPUT); digitalWrite(_powerPin, LOW); #endif - return; } - _serialDriver.stop(); + _started = false; } bool isActive() const override { - return _usingRak12500 ? true : _serialDriver.isActive(); + return _started; } + // Probes the I2C module on the possible power pins; the module is left powered. bool detect(uint32_t) override { if (_detected) return true; - _serialDriver.begin(); if (probeRak12500(WB_IO2) || probeRak12500(WB_IO4) || probeRak12500(WB_IO5)) { _detected = true; - return true; + _started = true; } - - if (_serialDriver.detect(0)) { - _detected = true; - return true; - } - - _serialDriver.stop(); - return false; + return _detected; } - bool usesRak12500() const { return _usingRak12500; } bool isDetected() const { return _detected; } - NmeaGpsDriver& nmeaDriver() { return _serialDriver; } - bool hasFix() { return _usingRak12500 && _gnss.getGnssFixOk(8); } + bool hasFix() { return _started && _gnss.getGnssFixOk(8); } long getLatitude() { return _gnss.getLatitude(2) / 10; } long getLongitude() { return _gnss.getLongitude(2) / 10; } long getAltitude() { return _gnss.getAltitude(2); } diff --git a/src/helpers/sensors/RakLocationProvider.h b/src/helpers/sensors/RakLocationProvider.h index 57ceb5e9f..d2c755e63 100644 --- a/src/helpers/sensors/RakLocationProvider.h +++ b/src/helpers/sensors/RakLocationProvider.h @@ -1,11 +1,15 @@ #pragma once #include "MicroNMEALocationProvider.h" -#include "RakGpsDriver.h" +#include "NmeaGpsDriver.h" +#include "RakI2cGpsDriver.h" class RakLocationProvider : public LocationProvider { - RakGpsDriver& _driver; + RakI2cGpsDriver& _driver; // RAK12500 (I2C) + NmeaGpsDriver _nmeaDriver; // serial NMEA module MicroNMEALocationProvider _nmea; + bool _detected = false; + bool _useI2c = false; uint32_t _gpsPeriodSeconds = 0; unsigned long _nextAcquisition = 0; unsigned long _acquisitionStarted = 0; @@ -24,73 +28,74 @@ class RakLocationProvider : public LocationProvider { } public: - RakLocationProvider(RakGpsDriver& driver, mesh::RTCClock* clock = nullptr) - : _driver(driver), _nmea(driver.nmeaDriver(), clock) {} + RakLocationProvider(RakI2cGpsDriver& driver, mesh::RTCClock* clock = nullptr, + HardwareSerial& serial = Serial1) + : _driver(driver), _nmeaDriver(serial), _nmea(_nmeaDriver, clock) {} void syncTime() override { LocationProvider::syncTime(); - if (!_driver.usesRak12500()) _nmea.syncTime(); + if (!_useI2c) _nmea.syncTime(); } long getLatitude() override { - return _driver.usesRak12500() ? _lastFix.latitude : _nmea.getLatitude(); + return _useI2c ? _lastFix.latitude : _nmea.getLatitude(); } long getLongitude() override { - return _driver.usesRak12500() ? _lastFix.longitude : _nmea.getLongitude(); + return _useI2c ? _lastFix.longitude : _nmea.getLongitude(); } long getAltitude() override { - return _driver.usesRak12500() ? _lastFix.altitude : _nmea.getAltitude(); + return _useI2c ? _lastFix.altitude : _nmea.getAltitude(); } long satellitesCount() override { - return _driver.usesRak12500() ? _lastFix.satellites : _nmea.satellitesCount(); + return _useI2c ? _lastFix.satellites : _nmea.satellitesCount(); } bool isValid() override { - return _driver.usesRak12500() ? _driver.hasFix() : _nmea.isValid(); + return _useI2c ? _driver.hasFix() : _nmea.isValid(); } LastFix getLastFix() const override { - return _driver.usesRak12500() ? _lastFix : _nmea.getLastFix(); + return _useI2c ? _lastFix : _nmea.getLastFix(); } long getTimestamp() override { - return _driver.usesRak12500() ? _lastFix.timestamp : _nmea.getTimestamp(); + return _useI2c ? _lastFix.timestamp : _nmea.getTimestamp(); } void sendSentence(const char* sentence) override { - if (!_driver.usesRak12500()) _nmea.sendSentence(sentence); + if (!_useI2c) _nmea.sendSentence(sentence); } bool waitFor(const char* prefix, uint32_t timeout_ms) override { - return _driver.usesRak12500() ? false : _nmea.waitFor(prefix, timeout_ms); + return _useI2c ? false : _nmea.waitFor(prefix, timeout_ms); } void drain() override { - if (!_driver.usesRak12500()) _nmea.drain(); + if (!_useI2c) _nmea.drain(); } void reset() override { - _driver.reset(); + if (!_useI2c) _nmea.reset(); } void begin() override { - if (_driver.isDetected() && _driver.usesRak12500()) { + if (_detected && _useI2c) { _driver.begin(); _acquiringPeriodically = _gpsPeriodSeconds > 0; _acquisitionStarted = millis(); - } else if (_driver.isDetected()) { + } else if (_detected) { _nmea.begin(); } else { - _driver.begin(); + _nmeaDriver.begin(); } } void stop() override { _acquiringPeriodically = false; - if (_driver.usesRak12500()) { + if (_useI2c) { _driver.stop(); } else { _nmea.stop(); @@ -98,9 +103,19 @@ public: } bool detect(uint32_t timeout_ms) override { - if (!_driver.detect(timeout_ms)) return false; + if (_detected) return true; - if (_driver.usesRak12500()) { + // the serial module is started first, then the I2C module is probed + _nmeaDriver.begin(); + if (_driver.detect(timeout_ms)) { + _useI2c = true; + } else if (!_nmeaDriver.detect(0)) { + _nmeaDriver.stop(); + return false; + } + _detected = true; + + if (_useI2c) { _acquiringPeriodically = _gpsPeriodSeconds > 0; _acquisitionStarted = millis(); } else { @@ -119,7 +134,7 @@ public: } void loop() override { - if (_driver.usesRak12500()) { + if (_useI2c) { if (_gpsOn) { if (_gpsPeriodSeconds > 0) { if (!_acquiringPeriodically && @@ -151,13 +166,13 @@ public: } bool isActive() override { - return _driver.isActive(); + return _useI2c ? _driver.isActive() : _nmea.isActive(); } void setGpsPeriod(uint32_t seconds) override { _gpsPeriodSeconds = seconds; _nextAcquisition = millis(); - if (!_driver.usesRak12500()) _nmea.setGpsPeriod(seconds); + if (!_useI2c) _nmea.setGpsPeriod(seconds); } uint32_t getGpsPeriod() const override { @@ -165,7 +180,7 @@ public: } void setGpsOn(bool on) override { - if (_driver.usesRak12500()) LocationProvider::setGpsOn(on); + if (_useI2c) LocationProvider::setGpsOn(on); else { _gpsOn = on; _nmea.setGpsOn(on); } } }; diff --git a/variants/gat562_30s_mesh_kit/target.cpp b/variants/gat562_30s_mesh_kit/target.cpp index ba81a690d..96e38a79e 100644 --- a/variants/gat562_30s_mesh_kit/target.cpp +++ b/variants/gat562_30s_mesh_kit/target.cpp @@ -27,7 +27,7 @@ AutoDiscoverRTCClock rtc_clock(fallback_clock); #if ENV_INCLUDE_GPS #include - RakGpsDriver gps_driver; + RakI2cGpsDriver gps_driver; RakLocationProvider location(gps_driver, &rtc_clock); EnvironmentSensorManager sensors(location); #else diff --git a/variants/rak3401/target.cpp b/variants/rak3401/target.cpp index 265019770..58c0e1d78 100644 --- a/variants/rak3401/target.cpp +++ b/variants/rak3401/target.cpp @@ -26,7 +26,7 @@ AutoDiscoverRTCClock rtc_clock(fallback_clock); #if ENV_INCLUDE_GPS #include - RakGpsDriver gps_driver; + RakI2cGpsDriver gps_driver; RakLocationProvider location(gps_driver, &rtc_clock); EnvironmentSensorManager sensors(location); #else diff --git a/variants/rak4631/target.cpp b/variants/rak4631/target.cpp index 06ccd23db..158de2b55 100644 --- a/variants/rak4631/target.cpp +++ b/variants/rak4631/target.cpp @@ -26,7 +26,7 @@ AutoDiscoverRTCClock rtc_clock(fallback_clock); #if ENV_INCLUDE_GPS #include - RakGpsDriver gps_driver; + RakI2cGpsDriver gps_driver; RakLocationProvider location(gps_driver, &rtc_clock); EnvironmentSensorManager sensors(location); #else