From 9c141919f687148262b3fc859b9ac98f9a894070 Mon Sep 17 00:00:00 2001 From: Dmitry Galenko Date: Mon, 3 Jul 2023 16:34:32 +0200 Subject: [PATCH] Initial support for MonteOps's fixed hardware platform (#2582) * Initial support for MonteOps's fixed hardware platform * Update platformio env config + cleanup * Fix platformio build * Fix platformio build * Fix wrong definition logic for NCP5623 * Fix another wrong definition logic for NCP5623, it's not board feature * Fix wrong definition logic for NCP5623 in External Notification code, it's not board feature * We need for CI magic here * Another fix related to NCP5623 * Fix cosmetic issue with redifined variable * Fix typo * Cleanup and update defs for HW1 * Fix OEM RAK4631 * Fix AQ sensor reading * Fix AQ sensor reading (better variant) * Fix build for other nRF52 devices * Replace HAS_EINK_RAK to RAK_4631 --- .github/workflows/main_matrix.yml | 1 + src/detect/ScanI2C.h | 4 +- src/detect/ScanI2CTwoWire.cpp | 7 +- src/detect/einkScan.h | 4 +- src/graphics/RAKled.h | 2 +- src/main.cpp | 20 +- src/modules/ExternalNotificationModule.cpp | 10 +- src/platform/nrf52/main-nrf52.cpp | 3 + variants/monteops_hw1/platformio.ini | 14 ++ variants/monteops_hw1/variant.cpp | 41 ++++ variants/monteops_hw1/variant.h | 240 +++++++++++++++++++++ variants/rak4631/variant.h | 5 + variants/rak4631_epaper/variant.h | 7 +- variants/rak4631_epaper_onrxtx/variant.h | 5 +- 14 files changed, 340 insertions(+), 23 deletions(-) create mode 100644 variants/monteops_hw1/platformio.ini create mode 100644 variants/monteops_hw1/variant.cpp create mode 100644 variants/monteops_hw1/variant.h diff --git a/.github/workflows/main_matrix.yml b/.github/workflows/main_matrix.yml index 1cac7479b..651a9a3ee 100644 --- a/.github/workflows/main_matrix.yml +++ b/.github/workflows/main_matrix.yml @@ -97,6 +97,7 @@ jobs: include: - board: rak4631 - board: rak4631_eink + - board: monteops_hw1 - board: t-echo - board: pca10059_diy_eink - board: feather_diy diff --git a/src/detect/ScanI2C.h b/src/detect/ScanI2C.h index a56ce86fe..4b6361cfd 100644 --- a/src/detect/ScanI2C.h +++ b/src/detect/ScanI2C.h @@ -33,7 +33,9 @@ class ScanI2C PMSA0031, MPU6050, LIS3DH, +#ifdef HAS_NCP5623 NCP5623, +#endif } DeviceType; // typedef uint8_t DeviceAddress; @@ -95,4 +97,4 @@ class ScanI2C private: bool shouldSuppressScreen = false; -}; +}; \ No newline at end of file diff --git a/src/detect/ScanI2CTwoWire.cpp b/src/detect/ScanI2CTwoWire.cpp index 7afb03ee2..7b5bb0a12 100644 --- a/src/detect/ScanI2CTwoWire.cpp +++ b/src/detect/ScanI2CTwoWire.cpp @@ -212,9 +212,10 @@ void ScanI2CTwoWire::scanPort(I2CPort port) } break; - SCAN_SIMPLE_CASE(ST7567_ADDRESS, SCREEN_ST7567, "st7567 display found\n") + SCAN_SIMPLE_CASE(ST7567_ADDRESS, SCREEN_ST7567, "st7567 display found\n"); +#ifdef HAS_NCP5623 SCAN_SIMPLE_CASE(NCP5623_ADDR, NCP5623, "NCP5623 RGB LED found\n"); - +#endif #ifdef HAS_PMU SCAN_SIMPLE_CASE(XPOWERS_AXP192_AXP2101_ADDRESS, PMU_AXP192_AXP2101, "axp192/axp2101 PMU found\n") #endif @@ -305,4 +306,4 @@ TwoWire *ScanI2CTwoWire::fetchI2CBus(ScanI2C::DeviceAddress address) const size_t ScanI2CTwoWire::countDevices() const { return foundDevices.size(); -} +} \ No newline at end of file diff --git a/src/detect/einkScan.h b/src/detect/einkScan.h index 8d82f4f81..6915709de 100644 --- a/src/detect/einkScan.h +++ b/src/detect/einkScan.h @@ -1,6 +1,6 @@ #include "../configuration.h" -#ifdef RAK4630 +#ifdef RAK_4631 #include "../main.h" #include @@ -64,4 +64,4 @@ void scanEInkDevice(void) LOG_DEBUG("EInk display not found\n"); SPI1.end(); } -#endif +#endif \ No newline at end of file diff --git a/src/graphics/RAKled.h b/src/graphics/RAKled.h index 06e2a717f..2e36b874a 100644 --- a/src/graphics/RAKled.h +++ b/src/graphics/RAKled.h @@ -1,6 +1,6 @@ #include "main.h" -#ifdef RAK4630 +#ifdef HAS_NCP5623 #include extern NCP5623 rgb; diff --git a/src/main.cpp b/src/main.cpp index c867930d0..2ff04475b 100644 --- a/src/main.cpp +++ b/src/main.cpp @@ -261,10 +261,11 @@ void setup() #endif #ifdef RAK4630 +#ifdef PIN_3V3_EN // We need to enable 3.3V periphery in order to scan it pinMode(PIN_3V3_EN, OUTPUT); digitalWrite(PIN_3V3_EN, HIGH); - +#endif #ifndef USE_EINK // RAK-12039 set pin for Air quality sensor pinMode(AQ_SET_PIN, OUTPUT); @@ -352,17 +353,18 @@ void setup() pmu_found = i2cScanner->exists(ScanI2C::DeviceType::PMU_AXP192_AXP2101); - /* - * There are a bunch of sensors that have no further logic than to be found and stuffed into the - * nodeTelemetrySensorsMap singleton. This wraps that logic in a temporary scope to declare the temporary field - * "found". - */ +/* + * There are a bunch of sensors that have no further logic than to be found and stuffed into the + * nodeTelemetrySensorsMap singleton. This wraps that logic in a temporary scope to declare the temporary field + * "found". + */ - // Only one supported RGB LED currently +// Only one supported RGB LED currently +#ifdef HAS_NCP5623 rgb_found = i2cScanner->find(ScanI2C::DeviceType::NCP5623); -// Start the RGB LED at 50% -#ifdef RAK4630 + // Start the RGB LED at 50% + if (rgb_found.type == ScanI2C::NCP5623) { rgb.begin(); rgb.setCurrent(10); diff --git a/src/modules/ExternalNotificationModule.cpp b/src/modules/ExternalNotificationModule.cpp index 82701cdc0..79bbb4028 100644 --- a/src/modules/ExternalNotificationModule.cpp +++ b/src/modules/ExternalNotificationModule.cpp @@ -10,7 +10,7 @@ #include "main.h" -#ifdef RAK4630 +#ifdef HAS_NCP5623 #include NCP5623 rgb; @@ -84,7 +84,7 @@ int32_t ExternalNotificationModule::runOnce() millis()) { getExternal(2) ? setExternalOff(2) : setExternalOn(2); } -#ifdef RAK4630 +#ifdef HAS_NCP5623 if (rgb_found.type == ScanI2C::NCP5623) { green = (green + 50) % 255; red = abs(red - green) % 255; @@ -127,7 +127,7 @@ void ExternalNotificationModule::setExternalOn(uint8_t index) digitalWrite(output, (moduleConfig.external_notification.active ? true : false)); break; } -#ifdef RAK4630 +#ifdef HAS_NCP5623 if (rgb_found.type == ScanI2C::NCP5623) { rgb.setColor(red, green, blue); } @@ -153,7 +153,7 @@ void ExternalNotificationModule::setExternalOff(uint8_t index) break; } -#ifdef RAK4630 +#ifdef HAS_NCP5623 if (rgb_found.type == ScanI2C::NCP5623) { red = 0; green = 0; @@ -235,7 +235,7 @@ ExternalNotificationModule::ExternalNotificationModule() LOG_INFO("Using Pin %i in PWM mode\n", config.device.buzzer_gpio); } } -#ifdef RAK4630 +#ifdef HAS_NCP5623 if (rgb_found.type == ScanI2C::NCP5623) { rgb.begin(); rgb.setCurrent(10); diff --git a/src/platform/nrf52/main-nrf52.cpp b/src/platform/nrf52/main-nrf52.cpp index c630aa13b..fd6fe2cc2 100644 --- a/src/platform/nrf52/main-nrf52.cpp +++ b/src/platform/nrf52/main-nrf52.cpp @@ -170,8 +170,11 @@ void cpuDeepSleep(uint32_t msecToWake) Serial1.end(); #endif setBluetoothEnable(false); + #ifdef RAK4630 +#ifdef PIN_3V3_EN digitalWrite(PIN_3V3_EN, LOW); +#endif #ifndef USE_EINK // RAK-12039 set pin for Air quality sensor digitalWrite(AQ_SET_PIN, LOW); diff --git a/variants/monteops_hw1/platformio.ini b/variants/monteops_hw1/platformio.ini new file mode 100644 index 000000000..f9d260e74 --- /dev/null +++ b/variants/monteops_hw1/platformio.ini @@ -0,0 +1,14 @@ +; MonteOps M.Node/M.Backbone/M.Eagle hardware based on hardware variant #1 (RAK4630 based) +[env:monteops_hw1] +extends = nrf52840_base +board = wiscore_rak4631 +build_flags = ${nrf52840_base.build_flags} -Ivariants/monteops_hw1 -D MONTEOPS_HW1 + -L "${platformio.libdeps_dir}/${this.__env__}/BSEC2 Software Library/src/cortex-m4/fpv4-sp-d16-hard" +build_src_filter = ${nrf52_base.build_src_filter} +<../variants/monteops_hw1> + + + +lib_deps = + ${nrf52840_base.lib_deps} + ${networking_base.lib_deps} + https://github.com/RAKWireless/RAK13800-W5100S.git#1.0.2 +debug_tool = jlink +; If not set we will default to uploading over serial (first it forces bootloader entry by talking 1200bps to cdcacm) +;upload_protocol = jlink \ No newline at end of file diff --git a/variants/monteops_hw1/variant.cpp b/variants/monteops_hw1/variant.cpp new file mode 100644 index 000000000..75cca1dc3 --- /dev/null +++ b/variants/monteops_hw1/variant.cpp @@ -0,0 +1,41 @@ +/* + 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 +*/ + +#include "variant.h" +#include "nrf.h" +#include "wiring_constants.h" +#include "wiring_digital.h" + +const uint32_t g_ADigitalPinMap[] = { + // P0 + 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, + + // P1 + 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47}; + +void initVariant() +{ + // LED1 & LED2 + pinMode(PIN_LED1, OUTPUT); + ledOff(PIN_LED1); + + pinMode(PIN_LED2, OUTPUT); + ledOff(PIN_LED2); +} diff --git a/variants/monteops_hw1/variant.h b/variants/monteops_hw1/variant.h new file mode 100644 index 000000000..866ddf471 --- /dev/null +++ b/variants/monteops_hw1/variant.h @@ -0,0 +1,240 @@ +/* + 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_MOPS_HW1_ +#define _VARIANT_MOPS_HW1_ + +#define RAK4630 + +// MonteOps hardware design variant +#ifndef MONTEOPS_HW1 +#define MONTEOPS_HW1 +#endif + +/** 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 PIN_LED2 (36) // Connected to WWAN host LED (if present) + +#define LED_BUILTIN PIN_LED1 +#define LED_CONN PIN_LED2 + +#define LED_GREEN PIN_LED1 +#define LED_BLUE PIN_LED2 + +#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 +#define PIN_BUTTON3 24 +#define PIN_BUTTON4 25 + +/* + * 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 PIN_AREF (2) +#define PIN_NFC1 (9) +#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; + +#define WIRE_INTERFACES_COUNT 1 + +#define PIN_WIRE_SDA (13) +#define PIN_WIRE_SCL (14) + +// 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 + +*/ + +#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) +#define SX126X_E22 // DIO2 controlls an antenna switch and the TCXO voltage is controlled by DIO3 + +#define PIN_GPS_RESET (34) // Must be P1.02 +// #define PIN_GPS_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 + +// 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 +// Definition of milliVolt per LSB => 3.0V ADC range and 12-bit ADC resolution = 3000mV/4096 +#define VBAT_MV_PER_LSB (0.73242188F) +// Voltage divider value => 1.5M + 1M voltage divider on VBAT = (1.5M / (1M + 1.5M)) +#define VBAT_DIVIDER (0.4F) +// Compensation factor for the VBAT divider +#define VBAT_DIVIDER_COMP (1.73) +// Fixed calculation of milliVolt from compensation value +#define REAL_VBAT_MV_PER_LSB (VBAT_DIVIDER_COMP * VBAT_MV_PER_LSB) +#undef AREF_VOLTAGE +#define AREF_VOLTAGE 3.0 +#define VBAT_AR_INTERNAL AR_INTERNAL_3_0 +#define ADC_MULTIPLIER VBAT_DIVIDER_COMP // REAL_VBAT_MV_PER_LSB +#define VBAT_RAW_TO_SCALED(x) (REAL_VBAT_MV_PER_LSB * x) + +//#define HAS_RTC 1 + +#define HAS_ETHERNET 1 + +#define PIN_ETHERNET_RESET 21 +#define PIN_ETHERNET_SS 26 // P0.26 QSPI_CS +#define ETH_SPI_PORT SPI1 +#define AQ_SET_PIN 10 + +#ifdef __cplusplus +} +#endif + +/*---------------------------------------------------------------------------- + * Arduino objects - C++ only + *----------------------------------------------------------------------------*/ + +#endif \ No newline at end of file diff --git a/variants/rak4631/variant.h b/variants/rak4631/variant.h index fe9f062c8..258e4eb3c 100644 --- a/variants/rak4631/variant.h +++ b/variants/rak4631/variant.h @@ -139,6 +139,9 @@ static const uint8_t SCK = PIN_SPI_SCK; // #define USE_EINK +// RAKRGB +#define HAS_NCP5623 + /* * Wire Interfaces */ @@ -255,6 +258,8 @@ SO GPIO 39/TXEN MAY NOT BE DEFINED FOR SUCCESSFUL OPERATION OF THE SX1262 - TG #define HAS_ETHERNET 1 +#define RAK_4631 1 + #define PIN_ETHERNET_RESET 21 #define PIN_ETHERNET_SS PIN_EINK_CS #define ETH_SPI_PORT SPI1 diff --git a/variants/rak4631_epaper/variant.h b/variants/rak4631_epaper/variant.h index a43229088..ad3e4b87f 100644 --- a/variants/rak4631_epaper/variant.h +++ b/variants/rak4631_epaper/variant.h @@ -139,6 +139,9 @@ static const uint8_t SCK = PIN_SPI_SCK; #define USE_EINK +// RAKRGB +#define HAS_NCP5623 + /* * Wire Interfaces */ @@ -226,6 +229,8 @@ static const uint8_t SCK = PIN_SPI_SCK; #define HAS_RTC 1 +#define RAK_4631 1 + #ifdef __cplusplus } #endif @@ -234,4 +239,4 @@ static const uint8_t SCK = PIN_SPI_SCK; * Arduino objects - C++ only *----------------------------------------------------------------------------*/ -#endif +#endif \ No newline at end of file diff --git a/variants/rak4631_epaper_onrxtx/variant.h b/variants/rak4631_epaper_onrxtx/variant.h index 44db0b7f0..e4d7c7d45 100644 --- a/variants/rak4631_epaper_onrxtx/variant.h +++ b/variants/rak4631_epaper_onrxtx/variant.h @@ -120,6 +120,9 @@ static const uint8_t SCK = PIN_SPI_SCK; // FIXME - I think this is actually just the board power enable - it enables power to the CPU also // #define PIN_EINK_PWR_ON (-1) +// RAKRGB +#define HAS_NCP5623 + /* * Wire Interfaces */ @@ -207,4 +210,4 @@ static const uint8_t SCK = PIN_SPI_SCK; * Arduino objects - C++ only *----------------------------------------------------------------------------*/ -#endif +#endif \ No newline at end of file