Support ChirpStack v4 #112

KrishnaIyer · 2024-02-28T10:27:41Z

Summary

Closes #58 and replaces #75

Changes

Make the configuration block consistent with other sources.
Setup CSv4 API.
Fix issues and test

Testing

Locally

Exports
--------
export CHIRPSTACK_API_URL="localhost:8080"
export CHIRPSTACK_API_KEY="eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhdWQiOiJjaGlycHN0YWNrIiwiaXNzIjoiY2hpcnBzdGFjayIsInN1YiI6ImQ5MGVmOGE5LTMyZTYtNDk5ZC1hMDMzLWEzN2MyZTEyNjc2MSIsInR5cCI6ImtleSJ9.W_njhPCsd8KEPQd8IoWtTzmv5d_nWyFXYWWrKECZ5Ec"
export JOIN_EUI="1111111111111111"
export FREQUENCY_PLAN_ID="EU_863_870"
export CHIRPSTACK_INSECURE="true"
export CHIRPSTACK_EXPORT_SESSION="true"


1. Device with session
./main chirpstack device 0004a30b001bc8a7 --dry-run
{"ids":{"device_id":"eui-0004a30b001bc8a7","application_ids":{"application_id":"chirpstack-832587699d72"},"dev_eui":"0004A30B001BC8A7","join_eui":"1111111111111111"},"name":"The Things Uno C8A7","attributes":{"chirpstack-device-profile":"1490385e-6368-41f7-b01b-4902773cab60","chirpstack-application-id":"18e5c56e-ef06-4ea9-b005-832587699d72"},"lorawan_version":"MAC_V1_0_2","lorawan_phy_version":"PHY_V1_0_2_REV_A","frequency_plan_id":"EU_863_870","supports_join":true,"root_keys":{"app_key":{"key":"5105D918B6EEEF8A22AA92B39D9EC718"}},"mac_settings":{"rx1_delay":1,"status_time_periodicity":"0.000000001s"},"mac_state":{"current_parameters":{"max_eirp":16,"adr_nb_trans":1,"rx1_delay":1,"rx2_frequency":"869525000","ping_slot_frequency":"869525000","beacon_frequency":"869525000","channels":[{"uplink_frequency":"868100000","downlink_frequency":"868100000","max_data_rate_index":5,"enable_uplink":true},{"uplink_frequency":"868300000","downlink_frequency":"868300000","max_data_rate_index":5,"enable_uplink":true},{"uplink_frequency":"868500000","downlink_frequency":"868500000","max_data_rate_index":5,"enable_uplink":true},{"uplink_frequency":"867100000","downlink_frequency":"867100000","max_data_rate_index":5,"enable_uplink":true},{"uplink_frequency":"867300000","downlink_frequency":"867300000","max_data_rate_index":5,"enable_uplink":true},{"uplink_frequency":"867500000","downlink_frequency":"867500000","max_data_rate_index":5,"enable_uplink":true},{"uplink_frequency":"867700000","downlink_frequency":"867700000","max_data_rate_index":5,"enable_uplink":true},{"uplink_frequency":"867900000","downlink_frequency":"867900000","max_data_rate_index":5,"enable_uplink":true}],"adr_ack_limit_exponent":"ADR_ACK_LIMIT_64","adr_ack_delay_exponent":"ADR_ACK_DELAY_32","ping_slot_data_rate_index_value":3},"desired_parameters":{"max_eirp":16,"adr_nb_trans":1,"rx1_delay":1,"rx2_frequency":"869525000","ping_slot_frequency":"869525000","beacon_frequency":"869525000","channels":[{"uplink_frequency":"868100000","downlink_frequency":"868100000","max_data_rate_index":5,"enable_uplink":true},{"uplink_frequency":"868300000","downlink_frequency":"868300000","max_data_rate_index":5,"enable_uplink":true},{"uplink_frequency":"868500000","downlink_frequency":"868500000","max_data_rate_index":5,"enable_uplink":true},{"uplink_frequency":"867100000","downlink_frequency":"867100000","max_data_rate_index":5,"enable_uplink":true},{"uplink_frequency":"867300000","downlink_frequency":"867300000","max_data_rate_index":5,"enable_uplink":true},{"uplink_frequency":"867500000","downlink_frequency":"867500000","max_data_rate_index":5,"enable_uplink":true},{"uplink_frequency":"867700000","downlink_frequency":"867700000","max_data_rate_index":5,"enable_uplink":true},{"uplink_frequency":"867900000","downlink_frequency":"867900000","max_data_rate_index":5,"enable_uplink":true}],"adr_ack_limit_exponent":"ADR_ACK_LIMIT_64","adr_ack_delay_exponent":"ADR_ACK_DELAY_32","ping_slot_data_rate_index_value":3},"lorawan_version":"MAC_V1_0_2"},"session":{"dev_addr":"006F0616","keys":{"session_key_id":"5nU66wHfm5eWbm3qzwzcpQ==","f_nwk_s_int_key":{"key":"4B40A8805F4B758E21BEEFDE90C9F2EA"},"app_s_key":{"key":"4F5179E867B163FED02B8C734628CDA8"}},"last_f_cnt_up":61,"last_n_f_cnt_down":8,"started_at":"2024-02-28T09:57:13.811927Z"},"formatters":{}}

2. Device without session
export CHIRPSTACK_EXPORT_SESSION="false"
{"ids":{"device_id":"eui-0004a30b001bc8a7","application_ids":{"application_id":"chirpstack-832587699d72"},"dev_eui":"0004A30B001BC8A7","join_eui":"1111111111111111"},"name":"The Things Uno C8A7","attributes":{"chirpstack-device-profile":"1490385e-6368-41f7-b01b-4902773cab60","chirpstack-application-id":"18e5c56e-ef06-4ea9-b005-832587699d72"},"lorawan_version":"MAC_V1_0_2","lorawan_phy_version":"PHY_V1_0_2_REV_A","frequency_plan_id":"EU_863_870","supports_join":true,"root_keys":{"app_key":{"key":"5105D918B6EEEF8A22AA92B39D9EC718"}},"mac_settings":{"status_time_periodicity":"0.000000001s"},"formatters":{}}


3. Application
./main chirpstack application 18e5c56e-ef06-4ea9-b005-832587699d72 --dry-run
{"ids":{"device_id":"eui-0004a30b001bc8a7","application_ids":{"application_id":"chirpstack-832587699d72"},"dev_eui":"0004A30B001BC8A7","join_eui":"1111111111111111"},"name":"The Things Uno C8A7","attributes":{"chirpstack-device-profile":"1490385e-6368-41f7-b01b-4902773cab60","chirpstack-application-id":"18e5c56e-ef06-4ea9-b005-832587699d72"},"lorawan_version":"MAC_V1_0_2","lorawan_phy_version":"PHY_V1_0_2_REV_A","frequency_plan_id":"EU_863_870","supports_join":true,"root_keys":{"app_key":{"key":"5105D918B6EEEF8A22AA92B39D9EC718"}},"mac_settings":{"status_time_periodicity":"0.000000001s"},"formatters":{}}

Regressions

NA. This is supporting a new API version.

Notes for Reviewers

This removes support for CS v3. This PR will target v0.12.0 and subsequent versions will only support CS v4.
CS v3 will remain supported in v0.11.x and Fix errors and panics in the chirpstack v3 source #111 will make sure that v3 works.
This is blocked on Fix errors and panics in the chirpstack v3 source #111 so that it can be released first.
TODO: Update documentation for CSv3 and CSv4 Add documentation for ChirpStack v4 TheThingsIndustries/lorawan-stack-docs#1281

Checklist

xx] Scope: The referenced issue is addressed, there are no unrelated changes.
Documentation: Relevant documentation is added or updated.
Changelog: Significant features, behavior changes, deprecations and fixes are added to CHANGELOG.md.

KrishnaIyer · 2024-03-06T17:33:45Z

CHANGELOG.md

+## [v0.11.2] (2024-03-04)
+
 ### Fixed

+- Exporting devices from ChirpStack v3.
+


This is a mistake in the current (released) changelog that's fixed.

johanstokking

LGTM, is this tested for OTAA and ABP?

KrishnaIyer · 2024-03-11T13:55:30Z

Now I did a test for ABP and made a couple of fixes. This is good to go.

happyRip

LGTM

adriansmares · 2024-03-11T15:28:06Z

pkg/source/chirpstack/config/config.go

 	c.JoinEUI = &types.EUI64{}
 	if err := c.JoinEUI.UnmarshalText([]byte(c.joinEUI)); err != nil {
 		return errInvalidJoinEUI.WithAttributes("join_eui", c.joinEUI)
 	}
+	c.caCertPath = os.Getenv("CHIRPSTACK_CA_CERT_PATH")


Won't this always override the CLI flags ?

Yes indeed. We do this for all the other sources the same currently. I think we should fix this separately for all the sources.

I would like to see this fixed everywhere before we make a new release, as it is very broken.

The change itself comes from #97 (comment) , but the idea is that only secrets shouldn't be initialized as flag defaults - the rest of the setup does not need this.

Sounds good to me. I'll file a follow up before we make a release.

KrishnaIyer added the status/blocked label Feb 28, 2024

KrishnaIyer added this to the Mar 2024 milestone Feb 28, 2024

KrishnaIyer self-assigned this Feb 28, 2024

KrishnaIyer mentioned this pull request Feb 28, 2024

Support migration from ChirpStack V4 #75

Closed

3 tasks

Base automatically changed from fix/chirpstack to master March 4, 2024 13:13

KrishnaIyer added 6 commits March 5, 2024 16:40

all: Adapt ChirpStack to v4

8ee784c

all: Make ChirpStack work

0943e96

all: Fix wrong usage of confirmed downlink counter

633458c

all: Generate MAC state

02ad46e

all: Add CS application ID to attributes

a5b51fe

dev: Update readme and changelog

6a6c1f7

KrishnaIyer force-pushed the chirpstack-v4 branch from 5e4223a to 6a6c1f7 Compare March 6, 2024 14:15

KrishnaIyer removed the status/blocked label Mar 6, 2024

KrishnaIyer mentioned this pull request Mar 6, 2024

Add documentation for ChirpStack v4 TheThingsIndustries/lorawan-stack-docs#1281

Merged

5 tasks

KrishnaIyer commented Mar 6, 2024

View reviewed changes

KrishnaIyer marked this pull request as ready for review March 6, 2024 17:34

KrishnaIyer requested review from happyRip, johanstokking and adriansmares as code owners March 6, 2024 17:34

johanstokking reviewed Mar 11, 2024

View reviewed changes

dev: Fix ABP export

d4f338a

KrishnaIyer requested a review from johanstokking March 11, 2024 13:56

happyRip approved these changes Mar 11, 2024

View reviewed changes

adriansmares reviewed Mar 11, 2024

View reviewed changes

KrishnaIyer requested a review from adriansmares March 12, 2024 12:32

adriansmares approved these changes Mar 12, 2024

View reviewed changes

KrishnaIyer merged commit 6283d81 into master Mar 13, 2024
3 checks passed

KrishnaIyer deleted the chirpstack-v4 branch March 13, 2024 10:17

KrishnaIyer mentioned this pull request Mar 13, 2024

Fix update of flags from the environment #117

Merged

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support ChirpStack v4 #112

Support ChirpStack v4 #112

KrishnaIyer commented Feb 28, 2024 •

edited

Loading

KrishnaIyer Mar 6, 2024

johanstokking left a comment

KrishnaIyer commented Mar 11, 2024

happyRip left a comment

adriansmares Mar 11, 2024

KrishnaIyer Mar 11, 2024

adriansmares Mar 11, 2024

KrishnaIyer Mar 12, 2024

Support ChirpStack v4 #112

Support ChirpStack v4 #112

Conversation

KrishnaIyer commented Feb 28, 2024 • edited Loading

Summary

Changes

Testing

Regressions

Notes for Reviewers

Checklist

KrishnaIyer Mar 6, 2024

Choose a reason for hiding this comment

johanstokking left a comment

Choose a reason for hiding this comment

KrishnaIyer commented Mar 11, 2024

happyRip left a comment

Choose a reason for hiding this comment

adriansmares Mar 11, 2024

Choose a reason for hiding this comment

KrishnaIyer Mar 11, 2024

Choose a reason for hiding this comment

adriansmares Mar 11, 2024

Choose a reason for hiding this comment

KrishnaIyer Mar 12, 2024

Choose a reason for hiding this comment

KrishnaIyer commented Feb 28, 2024 •

edited

Loading