added eink variant and removed some compile errors

2025-09-05 19:19:18 +00:00 · 2025-01-04 19:22:12 +01:00 · 2025-01-04 19:22:12 +01:00 · 62a0988a8a
commit 62a0988a8a
parent 8f584bb4ea
4 changed files with 420 additions and 1 deletions
--- a/variants/meshlink/variant.h
+++ b/variants/meshlink/variant.h
@ -18,7 +18,9 @@

 #ifndef _VARIANT_MESHLINK_
 #define _VARIANT_MESHLINK_
+#ifndef MESHLINK
 #define MESHLINK
+#endif
 /** Master clock frequency */
 #define VARIANT_MCK (64000000ul)

@ -116,7 +118,7 @@ static const uint8_t SCK = PIN_SPI_SCK;
 /*
 * eink display pins
 */
-#define USE_EINK
+//#define USE_EINK

 #define PIN_EINK_CS (15)
 #define PIN_EINK_BUSY (16)
--- a/variants/meshlink_eink/platformio.ini
+++ b/variants/meshlink_eink/platformio.ini
@ -0,0 +1,128 @@
+; The very slick RAK wireless RAK 4631 / 4630 board - Unified firmware for 5005/19003, with or without OLED RAK 1921
+[env:meshlink_eink]
+extends = nrf52840_base
+board = meshlink
+;board_check = true
+build_flags = ${nrf52840_base.build_flags} -I variants/meshlink_eink -D MESHLINK
+  -L "${platformio.libdeps_dir}/${this.__env__}/bsec2/src/cortex-m4/fpv4-sp-d16-hard"
+  -D GPS_POWER_TOGGLE ; comment this line to disable triple press function on the user button to turn off gps entirely.
+  -D EINK_DISPLAY_MODEL=GxEPD2_213_B74
+  -D EINK_WIDTH=250
+  -D EINK_HEIGHT=122
+  -D USE_EINK_DYNAMICDISPLAY            ; Enable Dynamic EInk
+  -D EINK_LIMIT_FASTREFRESH=5           ; How many consecutive fast-refreshes are permitted
+  -D EINK_LIMIT_RATE_BACKGROUND_SEC=30  ; Minimum interval between BACKGROUND updates
+  -D EINK_LIMIT_RATE_RESPONSIVE_SEC=1   ; Minimum interval between RESPONSIVE updates
+  -D EINK_LIMIT_GHOSTING_PX=2000        ; (Optional) How much image ghosting is tolerated
+  -D EINK_BACKGROUND_USES_FAST         ; (Optional) Use FAST refresh for both BACKGROUND and RESPONSIVE, until a limit is reached.
+  -D EINK_HASQUIRK_VICIOUSFASTREFRESH   ; Identify that pixels drawn by fast-refresh are harder to clear
+
+
+build_src_filter = ${nrf52_base.build_src_filter} +<../variants/meshlink_eink>
+lib_deps = 
+  ${nrf52840_base.lib_deps}
+  https://github.com/meshtastic/GxEPD2#55f618961db45a23eff0233546430f1e5a80f63a
+  melopero/Melopero RV3028@^1.1.0
+  rakwireless/RAKwireless NCP5623 RGB LED library@^1.0.2
+  beegee-tokyo/RAKwireless RAK12034@^1.0.0
+debug_tool = jlink
+
+
+
+; If not set we will default to uploading over serial (first it forces bootloader entry by talking 1200bps to cdcacm)
+; Note: as of 6/2013 the serial/bootloader based programming takes approximately 30 seconds
+;upload_protocol = jlink
+
+; Allows programming and debug via the RAK NanoDAP as the default debugger tool for the RAK4631 (it is only $10!)
+; programming time is about the same as the bootloader version.
+; For information on this see the meshtastic developers documentation for "Development on the NRF52"
+[env:meshlink_dbg]
+extends = env:meshlink
+board_level = extra
+
+; if the builtin version of openocd has a buggy version of semihosting, so use the external version
+; platform_packages = platformio/tool-openocd@^3.1200.0
+
+build_flags =
+  ${env:meshlink.build_flags}
+  -D USE_SEMIHOSTING
+
+lib_deps =
+  ${env:meshlink.lib_deps}
+  https://github.com/geeksville/Armduino-Semihosting.git#35b538fdf208c3530c1434cd099a08e486672ee4
+
+; NOTE: the pyocd support for semihosting is buggy.  So I switched to using the builtin platformio support for the stlink adapter which worked much better.
+; However the built in openocd version in platformio has buggy support for TCP to semihosting. 
+;
+; So I'm now trying the external openocd - but the openocd scripts for nrf52.cfg assume you are using a DAP adapter not an STLINK adapter.
+; In theory I could change those scripts.  But for now I'm trying going back to a DAP adapter but with the external openocd.
+
+upload_protocol = stlink
+; eventually use platformio/tool-pyocd@^2.3600.0 instad
+;upload_protocol = custom
+;upload_command = pyocd flash -t nrf52840 $UPLOADERFLAGS $SOURCE
+
+; We want the initial breakpoint at setup() instead of main().  Also we want to enable semihosting at that point so instead of
+; debug_init_break = tbreak setup
+; we just turn off the platformio tbreak and do it in .gdbinit (where we have more flexibility for scripting)
+; also we use a permanent breakpoint so it gets reused each time we restart the debugging session?
+debug_init_break = tbreak setup
+
+; Note: add "monitor arm semihosting_redirect tcp 4444 all" if you want the stdout from the device to go to that port number instead
+; (for use by meshtastic command line)
+;  monitor arm semihosting disable
+;  monitor debug_level 3
+;
+; IMPORTANT: fileio must be disabled before using port 5555 - openocd ver 0.12 has a bug where if enabled it never properly parses the special :tt name
+; for stdio access.
+;   monitor arm semihosting_redirect tcp 5555 stdio
+
+; Also note: it is _impossible_ to do non blocking reads on the semihost console port (an oversight when ARM specified the semihost API).
+; So we'll neve be able to general purpose bi-directional communication with the device over semihosting.
+debug_extra_cmds =
+  echo Running .gdbinit script
+  monitor arm semihosting enable
+  monitor arm semihosting_fileio enable
+  monitor arm semihosting_redirect disable
+  commands 1
+  echo Breakpoint at setup() has semihosting console, connect to it with "telnet localhost 5555"
+  set wantSemihost = true
+  set useSoftDevice = false
+  end
+
+
+; Only reprogram the board if the code has changed
+debug_load_mode = modified
+;debug_load_mode = manual
+debug_tool = stlink
+;debug_tool = custom
+; debug_server =
+;  openocd
+;  -f
+;  /usr/local/share/openocd/scripts/interface/stlink.cfg
+;  -f
+;  /usr/local/share/openocd/scripts/target/nrf52.cfg
+; $PLATFORMIO_CORE_DIR/packages/tool-openocd/openocd/scripts/interface/cmsis-dap.cfg
+
+; Allows programming and debug via the RAK NanoDAP as the default debugger tool for the RAK4631 (it is only $10!)
+; programming time is about the same as the bootloader version.
+; For information on this see the meshtastic developers documentation for "Development on the NRF52"
+; We manually pass in the elf file so that pyocd can reverse engineer FreeRTOS data (running threads, etc...)
+;debug_server =
+;  pyocd
+;  gdbserver
+;  -j
+;  ${platformio.workspace_dir}/..
+;  -t
+;  nrf52840
+;  --semihosting
+;  --elf
+;  ${platformio.build_dir}/${this.__env__}/firmware.elf
+
+; If you want to debug the semihosting support you can turn on extra logging in pyocd with
+;   -L
+;   pyocd.debug.semihost.trace=debug
+
+; The following is not needed because it automatically tries do this
+;debug_server_ready_pattern = -.*GDB server started on port \d+.*
+;debug_port = localhost:3333
--- a/variants/meshlink_eink/variant.cpp
+++ b/variants/meshlink_eink/variant.cpp
@ -0,0 +1,56 @@
+/*
+  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);
+    //pinMode(PIN_LED1, OUTPUT);
+    //digitalWrite(PIN_LED1, LOW);
+    pinMode(24,OUTPUT);
+    digitalWrite(24, HIGH);
+    //pinMode(25,OUTPUT);
+    //digitalWrite(25, HIGH);
+
+    // 3V3 Power Rail
+    pinMode(PIN_3V3_EN, OUTPUT);
+    digitalWrite(PIN_3V3_EN, HIGH);
+    //pinMode(PIN_GPS_EN, OUTPUT);
+    //digitalWrite(PIN_GPS_EN, HIGH);
+    //pinMode(GPS_TX_PIN, OUTPUT);
+    //pinMode(GPS_RX_PIN, INPUT_PULLUP);
+    
+}
--- a/variants/meshlink_eink/variant.h
+++ b/variants/meshlink_eink/variant.h
@ -0,0 +1,233 @@
+/*
+  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_MESHLINK_
+#define _VARIANT_MESHLINK_
+#ifndef MESHLINK
+#define MESHLINK
+#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 (2)
+#define NUM_ANALOG_OUTPUTS (0)
+
+
+
+#define BUTTON_PIN (38) // If defined, this will be used for user button presses,
+#define BUTTON_NEED_PULLUP
+
+
+// LEDs 
+#define PIN_LED1 (24) //24
+#define PIN_LED2 (-1)  //Watchdog enable pin25
+//#define PIN_LED3 (-1)
+
+//#define LED_RED PIN_LED1
+//#define LED_GREEN LED_PIN
+#define LED_BLUE PIN_LED1
+
+//#define LED_CONN PIN_LED1
+#define LED_BUILTIN PIN_LED1
+
+#define LED_STATE_ON 0 // State when LED is litted
+#define LED_INVERTED 1
+// Testing USB detection
+//#define NRF_APM
+/*
+ * Analog pins
+ */
+#define PIN_A0 (2)
+#define PIN_A7 (31)
+/*
+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)
+
+
+//static const uint8_t AREF = PIN_AREF;
+
+/*
+ * Serial interfaces
+ */
+#define PIN_SERIAL1_RX (40)
+#define PIN_SERIAL1_TX (7)
+
+
+
+
+/*
+ * SPI Interfaces
+ */
+#define SPI_INTERFACES_COUNT 2
+
+#define PIN_SPI_MISO (8) 
+#define PIN_SPI_MOSI (32 + 9) 
+#define PIN_SPI_SCK (11)  
+
+#define PIN_SPI1_MISO (23)
+#define PIN_SPI1_MOSI (21)
+#define PIN_SPI1_SCK (19)
+
+static const uint8_t SS = 12;
+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 USE_EINK
+
+#define PIN_EINK_CS (15)
+#define PIN_EINK_BUSY (16)
+#define PIN_EINK_DC (14)
+#define PIN_EINK_RES (17) //17
+#define PIN_EINK_SCLK (19)
+#define PIN_EINK_MOSI (21) // also called SDI
+
+
+
+/*
+ * Wire Interfaces
+ */
+#define WIRE_INTERFACES_COUNT 1
+
+#define PIN_WIRE_SDA (1)
+#define PIN_WIRE_SCL (27)
+
+// QSPI Pins
+#define PIN_QSPI_SCK 19
+#define PIN_QSPI_CS 22
+#define PIN_QSPI_IO0 21
+#define PIN_QSPI_IO1 23
+#define PIN_QSPI_IO2 32
+#define PIN_QSPI_IO3 20
+/*
+// On-board QSPI Flash
+#define EXTERNAL_FLASH_DEVICES W25Q16JVUXIQ
+#define EXTERNAL_FLASH_USE_QSPI
+
+*/
+
+/*
+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 (12)
+#define SX126X_DIO1 (32 + 1)
+#define SX126X_BUSY (32 + 3)
+#define SX126X_RESET (6)
+// #define SX126X_RXEN (13)
+// 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
+
+
+
+// enables 3.3V periphery like GPS or IO Module
+// Do not toggle this for GPS power savings
+#define PIN_3V3_EN (25)
+
+// 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 HAS_GPS 1
+//#define GNSS_ATGM336H
+//#define GPS_BAUDRATE 9600
+//#undef GPS_RX_PIN
+//#undef GPS_TX_PIN
+//#define PIN_GPS_PPS 36 // Pulse per second input from the GPS
+
+#define GPS_TX_PIN PIN_SERIAL1_RX // This is for bits going TOWARDS the CPU
+#define GPS_RX_PIN PIN_SERIAL1_TX // This is for bits going TOWARDS the GPS
+
+//#define GPS_THREAD_INTERVAL 50
+
+
+
+// Define pin to enable GPS toggle (set GPIO to LOW) via user button triple press
+#define PIN_GPS_EN (0)
+#define GPS_EN_ACTIVE LOW
+
+#define PIN_BUZZER PIN_A7 // IO3 is PWM2
+
+// 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.42
+
+
+
+
+
+#ifdef __cplusplus
+}
+#endif
+
+/*----------------------------------------------------------------------------
+ *        Arduino objects - C++ only
+ *----------------------------------------------------------------------------*/
+#endif