mirror of
https://github.com/alexhopeoconnor/firmware.git
synced 2026-10-17 09:01:30 +10:00
5f198c44d7
* nrf52: drop BSEC2/BME68x from the three targets nearest the flash cap
nrf52_promicro_diy_tcxo has been failing the nrf52_warm_region guard on
develop since 2026-08-05 (image ends at 0xEA918, 2328 B past the 0xEA000
warm-store cap). rak4631 and rak_wismesh_repeater_mini are ~14 KiB clear
while the nrf52 fleet drifts ~2 KiB/day, so both are close behind.
lib_ignore bsec2 + BME68x Sensor library defeats BME680Sensor's
__has_include(<bsec2.h>) gate, recovering ~46 KiB on each:
nrf52_promicro_diy_tcxo 0xEA918 (FAILED) -> 0xDF1A8, 43.6 KiB clear
rak4631 0xE6550 -> 0xDADE8, 60.0 KiB clear
rak_wismesh_repeater_mini 0xE65AC -> 0xDAE64, 59.9 KiB clear
This costs BME680/BME688 support, i.e. RAK1906 on WisBlock. It is a
temporary measure until the environmental sensor roster is opt-in per
board rather than linked into every target.
rak_wismesh_pocket inherits from env:rak4631 but has ~37 KiB clear, so it
is explicitly held at the nrf52 default and keeps BME680. Both lib_ignore
lists extend ${nrf52_base.lib_ignore} so BluetoothOTA and lvgl stay
ignored.
* nrf52: give the RAK boards BME680 back, drop their Ethernet instead
Excluding BSEC2 on rak4631 cost BME680/BME688 support, i.e. the RAK1906
WisBlock module - a common peripheral on the most popular nrf52 board. The
Ethernet stack is the better thing to lose: RAK13800 W5100S users are served
by the dedicated env:rak4631_eth_gw build, which has its own variant.h and
~163 KB clear, so the general-purpose image was carrying a networking stack
for hardware almost none of its users have.
rak_wismesh_pocket already set HAS_ETHERNET 0 for the same reason, so this
follows an existing in-tree precedent rather than inventing one.
rak4631 0xE6578 -> 0xE0D08, 35.7 KB clear (-21.6 KB)
rak_wismesh_repeater_mini -> 0xE0D58, 35.7 KB clear
rak4631_eth_gw -> 0xC1050, 163 KB clear (unchanged)
rak4631_eth_gw_dbg -> 0xC1210, 163 KB clear
That also brings rak4631 back under its declared flash budget in
bin/ram_budgets.json (766,216 vs 786,000 bytes), which develop is currently
failing - size-budget-gate is what has been ejecting PRs from the merge queue.
mqtt/ is deliberately kept: src/mqtt/MQTT.cpp carries both the networked
client (gated on HAS_NETWORKING, now 0) and the phone client-proxy path, so
dropping the directory would have removed MQTT-over-phone as well.
nrf52_promicro_diy_tcxo keeps the BSEC2 exclusion from the previous commit.
It has no Ethernet to reclaim - nrf52_base already filters mesh/eth, mesh/api
and mesh/wifi, and HAS_ETHERNET defaults to 0 - so the sensor library is the
only lever there. It goes 0xEA918 (FAILED) -> 0xDF1C0, 43.6 KB clear.
env:rak4631_eth_gw_dbg now extends env:rak4631_eth_gw rather than env:rak4631:
it already used the gateway env's build_flags and lib_deps, and only that env
still compiles mesh/eth + mesh/api.
* Address CodeRabbit review comments on PR #11363
- Condense the HAS_ETHERNET comment in rak4631/variant.h to one line
- Clarify rak4631/platformio.ini src-filter comment: Ethernet-free,
not networking-free, since MQTT is retained
- Restore custom_meshtastic_* metadata on env:rak4631_eth_gw so
env:rak4631_eth_gw_dbg (which now extends it) doesn't lose the
hw_model/display metadata it previously inherited via env:rak4631
---------
Co-authored-by: Jason P <applewiz@mac.com>
Co-authored-by: Claude <noreply@anthropic.com>
312 lines
9.3 KiB
C
312 lines
9.3 KiB
C
/*
|
|
Copyright (c) 2014-2015 Arduino LLC. All right reserved.
|
|
Copyright (c) 2016 Sandeep Mistry All right reserved.
|
|
Copyright (c) 2018, Adafruit Industries (adafruit.com)
|
|
|
|
This library is free software; you can redistribute it and/or
|
|
modify it under the terms of the GNU Lesser General Public
|
|
License as published by the Free Software Foundation; either
|
|
version 2.1 of the License, or (at your option) any later version.
|
|
This library is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
|
|
See the GNU Lesser General Public License for more details.
|
|
You should have received a copy of the GNU Lesser General Public
|
|
License along with this library; if not, write to the Free Software
|
|
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
|
|
*/
|
|
|
|
#ifndef _VARIANT_RAK4630_
|
|
#define _VARIANT_RAK4630_
|
|
|
|
#define RAK4630
|
|
|
|
/** Master clock frequency */
|
|
#define VARIANT_MCK (64000000ul)
|
|
|
|
#define USE_LFXO // Board uses 32khz crystal for LF
|
|
// define USE_LFRC // Board uses RC for LF
|
|
|
|
/*----------------------------------------------------------------------------
|
|
* Headers
|
|
*----------------------------------------------------------------------------*/
|
|
|
|
#include "WVariant.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif // __cplusplus
|
|
|
|
// Number of pins defined in PinDescription array
|
|
#define PINS_COUNT (48)
|
|
#define NUM_DIGITAL_PINS (48)
|
|
#define NUM_ANALOG_INPUTS (6)
|
|
#define NUM_ANALOG_OUTPUTS (0)
|
|
|
|
// LEDs
|
|
#define PIN_LED1 (35)
|
|
#define LED_BLUE (36)
|
|
|
|
#define LED_GREEN PIN_LED1
|
|
#define LED_NOTIFICATION LED_BLUE
|
|
|
|
#define LED_STATE_ON 1 // State when LED is litted
|
|
|
|
/*
|
|
* Buttons
|
|
*/
|
|
|
|
#define PIN_BUTTON1 9 // Pin for button on E-ink button module or IO expansion
|
|
#define BUTTON_NEED_PULLUP
|
|
#define PIN_BUTTON2 12
|
|
|
|
/*
|
|
* Analog pins
|
|
*/
|
|
#define PIN_A0 (5)
|
|
#define PIN_A1 (31)
|
|
#define PIN_A2 (28)
|
|
#define PIN_A3 (29)
|
|
#define PIN_A4 (30)
|
|
#define PIN_A5 (31)
|
|
#define PIN_A6 (0xff)
|
|
#define PIN_A7 (0xff)
|
|
|
|
static const uint8_t A0 = PIN_A0;
|
|
static const uint8_t A1 = PIN_A1;
|
|
static const uint8_t A2 = PIN_A2;
|
|
static const uint8_t A3 = PIN_A3;
|
|
static const uint8_t A4 = PIN_A4;
|
|
static const uint8_t A5 = PIN_A5;
|
|
static const uint8_t A6 = PIN_A6;
|
|
static const uint8_t A7 = PIN_A7;
|
|
#define ADC_RESOLUTION 14
|
|
|
|
// Other pins
|
|
#define WB_I2C1_SDA (13) // SENSOR_SLOT IO_SLOT
|
|
#define WB_I2C1_SCL (14) // SENSOR_SLOT IO_SLOT
|
|
|
|
#define PIN_AREF (2)
|
|
#define PIN_NFC1 (9)
|
|
#define WB_IO5 PIN_NFC1
|
|
#define WB_IO4 (4)
|
|
#define PIN_NFC2 (10)
|
|
|
|
static const uint8_t AREF = PIN_AREF;
|
|
|
|
/*
|
|
* Serial interfaces
|
|
*/
|
|
#define PIN_SERIAL1_RX (15)
|
|
#define PIN_SERIAL1_TX (16)
|
|
|
|
// Connected to Jlink CDC
|
|
#define PIN_SERIAL2_RX (8)
|
|
#define PIN_SERIAL2_TX (6)
|
|
|
|
/*
|
|
* SPI Interfaces
|
|
*/
|
|
#define SPI_INTERFACES_COUNT 2
|
|
|
|
#define PIN_SPI_MISO (45)
|
|
#define PIN_SPI_MOSI (44)
|
|
#define PIN_SPI_SCK (43)
|
|
|
|
#define PIN_SPI1_MISO (29) // (0 + 29)
|
|
#define PIN_SPI1_MOSI (30) // (0 + 30)
|
|
#define PIN_SPI1_SCK (3) // (0 + 3)
|
|
|
|
static const uint8_t SS = 42;
|
|
static const uint8_t MOSI = PIN_SPI_MOSI;
|
|
static const uint8_t MISO = PIN_SPI_MISO;
|
|
static const uint8_t SCK = PIN_SPI_SCK;
|
|
|
|
/*
|
|
* eink display pins
|
|
*/
|
|
|
|
#define PIN_EINK_CS (0 + 26)
|
|
#define PIN_EINK_BUSY (0 + 4)
|
|
#define PIN_EINK_DC (0 + 17)
|
|
#define PIN_EINK_RES (-1)
|
|
#define PIN_EINK_SCLK (0 + 3)
|
|
#define PIN_EINK_MOSI (0 + 30) // also called SDI
|
|
|
|
// #define USE_EINK
|
|
|
|
// RAKRGB
|
|
#define HAS_NCP5623
|
|
|
|
/*
|
|
* Wire Interfaces
|
|
*/
|
|
#define WIRE_INTERFACES_COUNT 1
|
|
|
|
#define PIN_WIRE_SDA (WB_I2C1_SDA)
|
|
#define PIN_WIRE_SCL (WB_I2C1_SCL)
|
|
|
|
// QSPI Pins
|
|
#define PIN_QSPI_SCK 3
|
|
#define PIN_QSPI_CS 26
|
|
#define PIN_QSPI_IO0 30
|
|
#define PIN_QSPI_IO1 29
|
|
#define PIN_QSPI_IO2 28
|
|
#define PIN_QSPI_IO3 2
|
|
|
|
// On-board QSPI Flash
|
|
#define EXTERNAL_FLASH_DEVICES IS25LP080D
|
|
#define EXTERNAL_FLASH_USE_QSPI
|
|
|
|
/* @note RAK5005-O GPIO mapping to RAK4631 GPIO ports
|
|
RAK5005-O <-> nRF52840
|
|
IO1 <-> P0.17 (Arduino GPIO number 17)
|
|
IO2 <-> P1.02 (Arduino GPIO number 34)
|
|
IO3 <-> P0.21 (Arduino GPIO number 21)
|
|
IO4 <-> P0.04 (Arduino GPIO number 4)
|
|
IO5 <-> P0.09 (Arduino GPIO number 9)
|
|
IO6 <-> P0.10 (Arduino GPIO number 10)
|
|
IO7 <-> P0.28 (Arduino GPIO number 28)
|
|
SW1 <-> P0.01 (Arduino GPIO number 1)
|
|
A0 <-> P0.04/AIN2 (Arduino Analog A2
|
|
A1 <-> P0.31/AIN7 (Arduino Analog A7
|
|
SPI_CS <-> P0.26 (Arduino GPIO number 26)
|
|
*/
|
|
|
|
// RAK4630 LoRa module
|
|
|
|
/* Setup of the SX1262 LoRa module ( https://docs.rakwireless.com/Product-Categories/WisBlock/RAK4631/Datasheet/ )
|
|
|
|
P1.10 NSS SPI NSS (Arduino GPIO number 42)
|
|
P1.11 SCK SPI CLK (Arduino GPIO number 43)
|
|
P1.12 MOSI SPI MOSI (Arduino GPIO number 44)
|
|
P1.13 MISO SPI MISO (Arduino GPIO number 45)
|
|
P1.14 BUSY BUSY signal (Arduino GPIO number 46)
|
|
P1.15 DIO1 DIO1 event interrupt (Arduino GPIO number 47)
|
|
P1.06 NRESET NRESET manual reset of the SX1262 (Arduino GPIO number 38)
|
|
|
|
Important for successful SX1262 initialization:
|
|
|
|
* Setup DIO2 to control the antenna switch
|
|
* Setup DIO3 to control the TCXO power supply
|
|
* Setup the SX1262 to use it's DCDC regulator and not the LDO
|
|
* RAK4630 schematics show GPIO P1.07 connected to the antenna switch, but it should not be initialized, as DIO2 will do the
|
|
control of the antenna switch
|
|
|
|
SO GPIO 39/TXEN MAY NOT BE DEFINED FOR SUCCESSFUL OPERATION OF THE SX1262 - TG
|
|
|
|
*/
|
|
|
|
// configure the SET pin on the RAK12039 sensor board to disable the sensor while not reading
|
|
// air quality telemetry. PIN_NFC2 doesn't seem to be used anywhere else in the codebase, but if
|
|
// you're having problems with your node behaving weirdly when a RAK12039 board isn't connected,
|
|
// try disabling this.
|
|
#define PMSA003I_ENABLE_PIN PIN_NFC2
|
|
|
|
#define DETECTION_SENSOR_EN 4
|
|
|
|
#define USE_SX1262
|
|
#define SX126X_CS (42)
|
|
#define SX126X_DIO1 (47)
|
|
#define SX126X_BUSY (46)
|
|
#define SX126X_RESET (38)
|
|
// #define SX126X_TXEN (39)
|
|
// #define SX126X_RXEN (37)
|
|
#define SX126X_POWER_EN (37)
|
|
// DIO2 controlls an antenna switch and the TCXO voltage is controlled by DIO3
|
|
#define SX126X_DIO2_AS_RF_SWITCH
|
|
#define SX126X_DIO3_TCXO_VOLTAGE 1.8
|
|
|
|
// Testing USB detection
|
|
#define NRF_APM
|
|
// If using a power chip like the INA3221 you can override the default battery voltage channel below
|
|
// and comment out NRF_APM to use the INA3221 instead of the USB detection for charging.
|
|
// INA3221Sensor.h provides compatibility aliases such as INA3221_CH1/INA3221_CH2/INA3221_CH3,
|
|
// so board variants can continue to use the channel names below.
|
|
// #define INA3221_BAT_CH INA3221_CH2
|
|
// #define INA3221_ENV_CH INA3221_CH1
|
|
|
|
// enables 3.3V periphery like GPS or IO Module
|
|
// Do not toggle this for GPS power savings
|
|
#define PIN_3V3_EN (34)
|
|
#define WB_IO2 PIN_3V3_EN
|
|
|
|
// GPS EN only for finished products that accept cutting 3V3_S with GPS off.
|
|
// Generic rak4631 / sensor bases keep this undefined so sensors on 3V3_S stay powered.
|
|
#if defined(WISMESH_POCKET) || defined(WISMESH_REPEATER_MINI)
|
|
#define PIN_GPS_EN PIN_3V3_EN
|
|
#endif
|
|
|
|
// RAK1910 GPS module
|
|
// If using the wisblock GPS module and pluged into Port A on WisBlock base
|
|
// IO1 is hooked to PPS (pin 12 on header) = gpio 17
|
|
// IO2 is hooked to GPS RESET = gpio 34, but it can not be used to this because IO2 is ALSO used to control 3V3_S power (1 is on).
|
|
// Therefore must be 1 to keep peripherals powered
|
|
// Power is on the controllable 3V3_S rail
|
|
// #define PIN_GPS_RESET (34)
|
|
// #define PIN_GPS_EN PIN_3V3_EN
|
|
#define PIN_GPS_PPS (17) // Pulse per second input from the GPS
|
|
|
|
#define GPS_RX_PIN PIN_SERIAL1_RX
|
|
#define GPS_TX_PIN PIN_SERIAL1_TX
|
|
|
|
// Define pin to enable GPS toggle (set GPIO to LOW) via user button triple press
|
|
|
|
// RAK12002 RTC Module
|
|
#define RV3028_RTC (uint8_t)0b1010010
|
|
|
|
// RAK18001 Buzzer in Slot C
|
|
#define PIN_BUZZER 21 // IO3 is PWM2
|
|
// NEW: set this via protobuf instead!
|
|
|
|
// RAK4631 custom ringtone (but not for Pocket - it uses the default ringtone)
|
|
#ifndef WISMESH_POCKET
|
|
#undef USERPREFS_RINGTONE_RTTTL
|
|
#define USERPREFS_RINGTONE_RTTTL "Rak:d=32,o=5,b=200:b7,p,b7,4p,p"
|
|
#endif
|
|
|
|
// Battery
|
|
// The battery sense is hooked to pin A0 (5)
|
|
#define BATTERY_PIN PIN_A0
|
|
// and has 12 bit resolution
|
|
#define BATTERY_SENSE_RESOLUTION_BITS 12
|
|
#define BATTERY_SENSE_RESOLUTION 4096.0
|
|
#undef AREF_VOLTAGE
|
|
#define AREF_VOLTAGE 3.0
|
|
#define VBAT_AR_INTERNAL AR_INTERNAL_3_0
|
|
#define ADC_MULTIPLIER 1.73
|
|
|
|
// RAK4630 AIN0 = nrf52840 AIN3 = Pin 5
|
|
#define BATTERY_LPCOMP_INPUT NRF_LPCOMP_INPUT_3
|
|
|
|
// We have AIN3 with a VBAT divider so AIN3 = VBAT * (1.5/2.5)
|
|
// We have the device going deep sleep under 3.1V, which is AIN3 = 1.86V
|
|
// So we can wake up when VBAT>=VDD is restored to 3.3V, where AIN3 = 1.98V
|
|
// 1.98/3.3 = 6/10, but that's close to the VBAT divider, so we
|
|
// pick 6/8VDD, which means VBAT=4.1V.
|
|
// Reference:
|
|
// VDD=3.3V AIN3=5/8*VDD=2.06V VBAT=1.66*AIN3=3.41V
|
|
// VDD=3.3V AIN3=11/16*VDD=2.26V VBAT=1.66*AIN3=3.76V
|
|
// VDD=3.3V AIN3=6/8*VDD=2.47V VBAT=1.66*AIN3=4.1V
|
|
#define BATTERY_LPCOMP_THRESHOLD NRF_LPCOMP_REF_SUPPLY_11_16
|
|
|
|
// General-purpose RAK4631 builds disable Ethernet; use env:rak4631_eth_gw for RAK13800 W5100S.
|
|
#define HAS_ETHERNET 0
|
|
|
|
#define RAK_4631 1
|
|
|
|
#define PIN_ETHERNET_RESET 21
|
|
#define PIN_ETHERNET_SS PIN_EINK_CS
|
|
#define ETH_SPI_PORT SPI1
|
|
#define AQ_SET_PIN 10
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
/*----------------------------------------------------------------------------
|
|
* Arduino objects - C++ only
|
|
*----------------------------------------------------------------------------*/
|
|
|
|
#endif
|