Is there a way to customize the ADR algorithm

shirou_Emiya · March 14, 2021, 1:48pm

I mean by rewriting some relevant source code at github (I don’t know if they need to be compiled) to set the relevant content of ADR by myself.

I really need help.

bconway · March 14, 2021, 2:03pm

Found this in the search, which Mr. Brocaar answers:

shirou_Emiya · March 14, 2021, 2:11pm

It is hard to understand and change the code.

brocaar · March 18, 2021, 3:26pm

It should be pretty straightforward, see this example:

github.com

brocaar/chirpstack-network-server/blob/master/examples/adr-plugin/main.go#L23


// ID must return the plugin identifier.
func (h *Handler) ID() (string, error) {
	return "example_plugin", nil
}
// Name must return a human-readable name.
func (h *Handler) Name() (string, error) {
	return "Example ADR plugin", nil
}
// Handle handles the ADR and returns the (new) parameters.
func (h *Handler) Handle(req adr.HandleRequest) (adr.HandleResponse, error) {
	return adr.HandleResponse{
		DR:           req.DR,
		TxPowerIndex: req.TxPowerIndex,
		NbTrans:      req.NbTrans,
	}, nil
}
func main() {
	handler := &Handler{}

You receive a req variable with all the parameters which you can use for your own ADR algorithm and then you return the DR, TX Power and NbTrans values that the NS must sent to the device.

shirou_Emiya · March 19, 2021, 1:10am

My understanding is as follows:

The code you paste is an empty template, and I have to write codes at the My own codes part, which includes parameters like req.MaxDR, req.MinDR and So on.

If this is not an empty template, but a written example, it will be more conducive to modification. For example, there may include the default ADR code to show how to call parameters to process.

func (h *Handler) Handle(req adr.HandleRequest) (adr.HandleResponse, error) {

        ***My own codes***

	return adr.HandleResponse{
		DR:           req.DR,
		TxPowerIndex: req.TxPowerIndex,
		NbTrans:      req.NbTrans,
	}, nil
}

And if I understand correctly, how can I successfully execute the modified code by compiling?

brocaar · March 19, 2021, 9:22am

You will find the default ADR implementation here:

github.com

brocaar/chirpstack-network-server/blob/master/internal/adr/default.go

package adr

import "github.com/brocaar/chirpstack-network-server/adr"

// DefaultHandler implements the default ADR handler.
type DefaultHandler struct{}

// ID returns the default ID.
func (h *DefaultHandler) ID() (string, error) {
	return "default", nil
}

// Name returns the default name.
func (h *DefaultHandler) Name() (string, error) {
	return "Default ADR algorithm", nil
}

// Handle handles the ADR request.
func (h *DefaultHandler) Handle(req adr.HandleRequest) (adr.HandleResponse, error) {
	// This defines the default response, which is equal to the current device

This file has been truncated. show original

This is an example how you can test your code:

github.com

brocaar/chirpstack-network-server/blob/master/internal/adr/default_test.go

package adr

import (
	"fmt"
	"testing"

	"github.com/brocaar/chirpstack-network-server/adr"
	"github.com/stretchr/testify/require"
)

func TestDefaultHandler(t *testing.T) {
	h := &DefaultHandler{}

	t.Run("ID", func(t *testing.T) {
		assert := require.New(t)
		id, err := h.ID()
		assert.NoError(err)
		assert.Equal("default", id)
	})

This file has been truncated. show original

You can compile the plugin file like any other Go binary

shirou_Emiya · March 20, 2021, 12:17pm

When I want to refer to external dependencies:

go get github.com/brocaar/chirpstack-network-server/adr

go get: module github.com/brocaar/chirpstack-network-server@upgrade found (v2.5.0
+incompatible), but does not contain package github.com/brocaar/chirpstack-networ
k-server/adr

Repeatedly report the following error, I wonder if there is something wrong with the URL in import:

go.go:7:2: no required module provides package github.com/brocaar/chirpstack-network-server/adr; to add it:
	go get github.com/brocaar/chirpstack-network-server/adr

brocaar · April 1, 2021, 9:41am

Sorry, my fault. The example works since it is within the github.com/brocaar/chirpstack-network-server Go module, but since the version is v3.x.x, the Go module should have been named github.com/brocaar/chirpstack-network-server/v3.

This commit fixes this + updates all the imports:

https://github.com/brocaar/chirpstack-network-server/commit/604d5e8825e50ccca67d2ebfcca55ab0de4dca25.

When the next version is tagged, you will be able to run go get github.com/brocaar/chirpstack-network-server/v3@v3.y.z (where v3.y.z matches an actual version number).

shirou_Emiya · April 21, 2021, 1:05am

go get github.com/brocaar/chirpstack-network-server/v3@v3.12.3

go get github.com/brocaar/chirpstack-network-server/v3@v3.12.3: github.com/brocaar/chirpstack-network-server@v3.12.3: invalid version: module contains a go.mod file, so ma
jor version must be compatible: should be v0 or v1, not v3

At present, the attempt is still unsuccessful. Is there any progress?