Add RAKwireless WisMesh Hub (RAK2560/RAK9154) #4117

beegee-tokyo · 2024-06-16T06:47:22Z

RAKwireless is planning to offer the RAK2560 SensorHub and RAK9154 Solar Battery Lite preflashed with Meshtastic Firmware as a Meshtastic Router or Repeater under the name WisMesh Hub.

This pull request adds support for the RAK2560 device and the communication protocol for the RAK9154 Solar Battery Lite to Meshtastic.

The RAK2560 device is based on the RAK4630 (used on RAK4631) stamp module and is a low power device with LoRa and BLE connectivity.

LoRa 868-930 MHz support
Nordic nRF52840 MCU with Semtech SX1262 LoRa transceiver
12 VDC over power supply or solar panel
Embedded antenna (external antenna optional)
- High efficiency (over 75%) LoRa Band 860~930 MHz
- Support 700~960 MHz and 1700~2170 MHz.
IP66-rated waterproof enclosure

The RAK9154 is a solar panel/battery combination with

Battery capacity: 5200 mAh
Operating temperature: -20～60° C
Dimensions: 180 x 130 x 60 mm
Outputs: one 12 VDC output for Sensor Hub
Integrated BMS and heater
Supported mounting pole diameter: 55～80 mm (Other mounting options possible)

WisMesh Hub in Meshtastic mobile app (temperature/humidity is optional and requires RAk1901 module inside the RAK2560):

CLAassistant · 2024-06-16T06:47:27Z

All committers have signed the CLA.

CLAassistant · 2024-06-16T06:47:27Z

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
_{You have signed the CLA already but the status is still pending? Let us recheck it.}

beegee-tokyo · 2024-06-16T07:23:45Z

Test installation (with internal antenna)

caveman99

Thanks for the contribution, this is a very useful device in the line-up cause we have many requests for ready-made devices. Please see my review comments, hoping i judged the intent of the changes correctly.

caveman99 · 2024-06-16T09:17:36Z

.vscode/extensions.json

    ],
+    "unwantedRecommendations": [
+        "ms-vscode.cpptools-extension-pack"
+    ]
 }


Please don't check in the vscode files. This will cause merge conflicts all over the place.

caveman99 · 2024-06-16T09:23:05Z

src/modules/Telemetry/Sensor/RAK9154Sensor.cpp

@@ -0,0 +1,191 @@
+#ifdef HAS_RAKPROT 


I don't think the RAK9154 support is places correctly. The Telemetry folder is for devices that actually transmit values over Lora. This looks more like gathering values for internal processing. If this is only ever used once for this particular device, you can as well put it in the variant folder and skip deriving it from TelemetryModule. If you add the OSThread class to inheritance you can use the runOnce model without having to define it as a sensor (which it isn't in the meshtastic sense)

caveman99 · 2024-06-16T09:24:17Z

src/modules/Telemetry/Sensor/RAK9154Sensor.cpp

+
+bool RAK9154Sensor::getMetrics(meshtastic_Telemetry *measurement)
+{
+	return true;


Alternatively if the values really should be able to go out over the mesh, you need to implementthese functions :-)

caveman99 · 2024-06-16T09:27:57Z

variants/rak4631/variant.h

+// #define PIN_GPS_EN PIN_3V3_EN
+// Disable GPS
+#define MESHTASTIC_EXCLUDE_GPS 1
+#else


This does not only disable GPS but removes all GPS code from the binary. I assume goal is to have a GPS active on Serial2?

@caveman99 Just thinking out loud, should this go into its own variant/rak2560/ - otherwise some code gets clobbered (eg, the JLink CDC pin assignment, unsure if that's used but noticed it while going through the changes)

@Talie5in
I can create extra variant files for RAK2560, but I wanted to avoid double maintenance, RAK2560 is just a RAK4631 on a different PCB with a solar power battery. With both in one variant.h I have to work only with one file if there are changes required.

Open for suggestions @caveman99

really depends on how much it diverges from a stock 4631+Baseboard. Right now there's only a handful of defines. In the long term i think i'd prefer a separate variant.h file, since this is more or less a fixed configuration while we have to account for all sorts of modules on the wisblock boards. We broke out an EINK version too, since the defines were diverging too much and it got harder and harder to keep them apart.

caveman99 · 2024-06-16T09:32:47Z

also worth noting: We do have an ENUM for devices to identify who is actually talking to us. Right now this code is masquerading as a RAK4631. I'd really like to assign this its own RAK2560 label or even better call it WISMESH-HUB. If you agree i'd open up a pull request to the devicenum protobuf.

beegee-tokyo · 2024-06-16T10:16:03Z

Hi @caveman99

(1) "Please don't check in the vscode files"
Not sure what happened, I guess my PIO installation messed it up. I will reverse that.

(2) " if the values really should be able to go out "
Personally I am not sure if a device will/should report it's battery level over the mesh. I guess that having them in the telemetry in power metrics should be sufficient. I will move the RAK9154 functions into the variant folder and check if compilation works. If users want these values over the mesh, we can add this later.

(3) "I assume goal is to have a GPS active on Serial2?"
The RAK2560 doesn't have GPS by default, I did some tests through Serial 2, but the GPS module was not detected. That's why I removed GPS for now. I hope with the help of my R&D colleagues at RAK I get it to work, but for now it doesn't.

(4) "I'd really like to assign this its own RAK2560 label"
Yeah, I wanted that, but I was not sure how to do it. For the name itslef, "WisMesh Hub" as a name is still under discussion. Better we use the RAK2560 as name, similar as for the RAK10700, which is a pre-assembled device as well.

I will work on the changes and push again.

caveman99 · 2024-06-16T10:27:23Z

regarding the vscode stuff, it does that all over the place. Just have to be careful to not check the changes in, we supply the files as a default config.
the procedure is to configure a new values in meshtastic/protobufs - same for new (remote) sensors. I'll do that for the RAK2560 now.

Another request: can you enable 'maintainer edits' on the pull requests? our repo is set up so we cant' merge outdated pull requests, and we need to be able to update your fork with other changes (rebase).

beegee-tokyo · 2024-06-16T10:52:51Z

I am sure I enabled "maintainer edits", but it might be related to this strange response I got to the CLA:
First it said signed, then it says "not signed yet". I clicked the "recheck" several times already.

beegee-tokyo · 2024-06-16T10:57:51Z

thebentern · 2024-06-16T12:40:41Z

The RAK2560 HW_MODEL protobufs should be available downstream now. @caveman99 this would just need to be pretty much a carbon copy of the RAK4631 but with the variant.h changes and the additional macro?

beegee-tokyo · 2024-06-16T13:09:46Z

The RAK2560 HW_MODEL protobufs should be available downstream now. @caveman99 this would just need to be pretty much a carbon copy of the RAK4631 but with the variant.h changes and the additional macro?

@thebentern
Anything I need add in the variants files?

thebentern · 2024-06-16T13:14:19Z

@thebentern Anything I need add in the variants files?

I believe all you should need is to pull over what you have for the RAK4631 variant.h, since they're identical except for the serial port changes and additional macros.

caveman99 · 2024-06-16T13:23:53Z

variants/rak2560/platformio.ini

+;upload_protocol = jlink
+extra_scripts = 
+	${env.extra_scripts}
+	../firmware/variants/rak2560/create_uf2.py	


you can drop the ../firmware part, this doesn't work if the local folder is named differently. variants/rak2560/create_uf2.py should pick the script up just fine. The platfirmio.ini always assumes workspace root.

caveman99 · 2024-06-16T13:25:08Z

variants/rak2560/platformio.ini

+  -L "${platformio.libdeps_dir}/${this.__env__}/bsec2/src/cortex-m4/fpv4-sp-d16-hard"
+  -DGPS_POWER_TOGGLE ; comment this line to disable triple press function on the user button to turn off gps entirely.
+  -DHAS_RAKPROT=1 ; Define if RAk OneWireSerial is used (disables GPS)
+build_src_filter = ${nrf52_base.build_src_filter} +<../variants/rak2560> +<mesh/eth/> +<mesh/api/> +<mqtt/>


src/platform/nrf52/architecture.h needs to be amended to pick up the new hardware model, before the plain 4630 is found.

GUVWAF · 2024-06-16T13:39:42Z

Also maybe slightly unrelated to this PR and needless to say, but if you plan to pre-flash them as Router/Repeater please make sure to not copy completely the same configuration to each device, because all devices will get the same unique NodeNum and that leads to issues on the mesh.

beegee-tokyo · 2024-06-17T01:34:43Z

@caveman99 @thebentern

Thanks a lot for the support to merge this in.

@GUVWAF
We will flash a plain Meshtastic firmware with no setup (not even as router or repeater).

beegee-tokyo · 2024-06-17T04:02:49Z

@caveman99 @thebentern

Last question

Created a firmware from original sources for RAK2560.
The Meshtastic App now shows "Hardware model: UNRECOGNIZED"
Does it need an app update to show the model correct?

geeksville · 2024-06-17T04:20:52Z

hi @beegee-tokyo I just happened to notice this bug and your comment. Yeah. Clients will eventually get the latest protobuf code and then properly convert the enum (which they don't recognize without those new strings) to the device name.

(long time no see - I hope all is great for you -kevin).

beegee-tokyo · 2024-06-17T04:33:03Z

@geeksville

All good here, busy with RAKwireless WisBlock. And as RAKwireless is now jumping full speed on the Meshtastic train, I am on your trails now.

No problem for now with the module name, it will take some weeks (I guess) before you can officially buy it.
I am just ahead with the preparation and testing.

geeksville · 2024-06-17T05:09:01Z

@beegee-tokyo cool beans. I've been away from meshtastic for a while but I've decided to devote some time to really decreasing power consumption. I'm initially using a RAK4630 that I had in a drawer as my reference platform for this work. It seems great!

beegee-tokyo · 2024-06-17T05:25:17Z

@geeksville
Let me know if you need anything. I am sitting literally on the source 😁
Btw, we have distributor in US, Rokland in Florida (I think) if you need any parts.

Add RAK2560/RAK9154

d7c52c3

Fix build error for none RAK2560 devices

5e01b42

caveman99 requested changes Jun 16, 2024

View reviewed changes

beegee-tokyo and others added 2 commits June 16, 2024 19:45

Move RAK9154 to variants, fix json

85d621d

Merge branch 'master' into master

0c45c99

beegee-tokyo added 2 commits June 16, 2024 21:06

Separate RAK4631 and RAK2560 variants

f50073e

Merge branch 'master' of https://github.com/beegee-tokyo/firmware

e546220

caveman99 reviewed Jun 16, 2024

View reviewed changes

caveman99 added 4 commits June 16, 2024 16:29

trunk fmt

ceb884c

add proper RAK variant and change pathspec

11c3ca5

tryfix linter error

4fe281c

more try more fix

aca0807

caveman99 approved these changes Jun 16, 2024

View reviewed changes

caveman99 merged commit 02050a4 into meshtastic:master Jun 16, 2024
11 of 83 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add RAKwireless WisMesh Hub (RAK2560/RAK9154) #4117

Add RAKwireless WisMesh Hub (RAK2560/RAK9154) #4117

beegee-tokyo commented Jun 16, 2024 •

edited

Loading

CLAassistant commented Jun 16, 2024 •

edited

Loading

CLAassistant commented Jun 16, 2024

beegee-tokyo commented Jun 16, 2024

caveman99 left a comment

caveman99 Jun 16, 2024

caveman99 Jun 16, 2024

caveman99 Jun 16, 2024

caveman99 Jun 16, 2024

Talie5in Jun 16, 2024 •

edited

Loading

beegee-tokyo Jun 16, 2024

caveman99 Jun 16, 2024

caveman99 commented Jun 16, 2024

beegee-tokyo commented Jun 16, 2024

caveman99 commented Jun 16, 2024 •

edited

Loading

beegee-tokyo commented Jun 16, 2024 •

edited

Loading

beegee-tokyo commented Jun 16, 2024

thebentern commented Jun 16, 2024 •

edited

Loading

beegee-tokyo commented Jun 16, 2024

thebentern commented Jun 16, 2024

caveman99 Jun 16, 2024

caveman99 Jun 16, 2024

GUVWAF commented Jun 16, 2024

beegee-tokyo commented Jun 17, 2024

beegee-tokyo commented Jun 17, 2024

geeksville commented Jun 17, 2024

beegee-tokyo commented Jun 17, 2024

geeksville commented Jun 17, 2024

beegee-tokyo commented Jun 17, 2024

Add RAKwireless WisMesh Hub (RAK2560/RAK9154) #4117

Add RAKwireless WisMesh Hub (RAK2560/RAK9154) #4117

Conversation

beegee-tokyo commented Jun 16, 2024 • edited Loading

CLAassistant commented Jun 16, 2024 • edited Loading

CLAassistant commented Jun 16, 2024

beegee-tokyo commented Jun 16, 2024

caveman99 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Talie5in Jun 16, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

caveman99 commented Jun 16, 2024

beegee-tokyo commented Jun 16, 2024

caveman99 commented Jun 16, 2024 • edited Loading

beegee-tokyo commented Jun 16, 2024 • edited Loading

beegee-tokyo commented Jun 16, 2024

thebentern commented Jun 16, 2024 • edited Loading

beegee-tokyo commented Jun 16, 2024

thebentern commented Jun 16, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

GUVWAF commented Jun 16, 2024

beegee-tokyo commented Jun 17, 2024

beegee-tokyo commented Jun 17, 2024

geeksville commented Jun 17, 2024

beegee-tokyo commented Jun 17, 2024

geeksville commented Jun 17, 2024

beegee-tokyo commented Jun 17, 2024

beegee-tokyo commented Jun 16, 2024 •

edited

Loading

CLAassistant commented Jun 16, 2024 •

edited

Loading

Talie5in Jun 16, 2024 •

edited

Loading

caveman99 commented Jun 16, 2024 •

edited

Loading

beegee-tokyo commented Jun 16, 2024 •

edited

Loading

thebentern commented Jun 16, 2024 •

edited

Loading