lora

package
v0.14.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 29, 2024 License: Apache-2.0 Imports: 7 Imported by: 0

README

LoRa Adapter

Adapter between Magistrala IoT system and LoRa Server.

This adapter sits between Magistrala and LoRa Server and just forwards the messages from one system to another via MQTT protocol, using the adequate MQTT topics and in the good message format (JSON and SenML), i.e. respecting the APIs of both systems.

LoRa Server is used for connectivity layer and data is pushed via this adapter service to Magistrala, where it is persisted and routed to other protocols via Magistrala multi-protocol message broker. Magistrala adds user accounts, application management and security in order to obtain the overall end-to-end LoRa solution.

Configuration

The service is configured using the environment variables presented in the following table. Note that any unset variables will be replaced with their default values.

Variable Description Default
MG_LORA_ADAPTER_LOG_LEVEL Log level for the LoRa Adapter (debug, info, warn, error) info
MG_LORA_ADAPTER_HTTP_HOST Service LoRa host ""
MG_LORA_ADAPTER_HTTP_PORT Service LoRa port 9017
MG_LORA_ADAPTER_HTTP_SERVER_CERT Path to the PEM encoded server certificate file ""
MG_LORA_ADAPTER_HTTP_SERVER_KEY Path to the PEM encoded server key file ""
MG_LORA_ADAPTER_MESSAGES_URL LoRa adapter MQTT broker URL tcp://localhost:1883
MG_LORA_ADAPTER_MESSAGES_TOPIC LoRa adapter MQTT subscriber Topic application/+/device/+/event/up
MG_LORA_ADAPTER_MESSAGES_USER LoRa adapter MQTT subscriber Username ""
MG_LORA_ADAPTER_MESSAGES_PASS LoRa adapter MQTT subscriber Password ""
MG_LORA_ADAPTER_MESSAGES_TIMEOUT LoRa adapter MQTT subscriber Timeout 30s
MG_LORA_ADAPTER_ROUTE_MAP_URL Route-map database URL redis://localhost:6379
MG_ES_URL Event source URL nats://localhost:4222
MG_LORA_ADAPTER_EVENT_CONSUMER Service event consumer name lora-adapter
MG_MESSAGE_BROKER_URL Message broker instance URL nats://localhost:4222
MG_JAEGER_URL Jaeger server URL http://localhost:14268/api/traces
MG_JAEGER_TRACE_RATIO Jaeger sampling ratio 1.0
MG_SEND_TELEMETRY Send telemetry to magistrala call home server true
MG_LORA_ADAPTER_INSTANCE_ID Service instance ID ""

Deployment

The service itself is distributed as Docker container. Check the lora-adapter service section in docker-compose to see how service is deployed.

Running this service outside of container requires working instance of the message broker service, LoRa server, things service and Jaeger server. To start the service outside of the container, execute the following shell script:

# download the latest version of the service
git clone https://github.com/absmach/magistrala

cd magistrala

# compile the lora adapter
make lora

# copy binary to bin
make install

# set the environment variables and run the service
MG_LORA_ADAPTER_LOG_LEVEL=info \
MG_LORA_ADAPTER_HTTP_HOST=localhost \
MG_LORA_ADAPTER_HTTP_PORT=9017 \
MG_LORA_ADAPTER_HTTP_SERVER_CERT="" \
MG_LORA_ADAPTER_HTTP_SERVER_KEY="" \
MG_LORA_ADAPTER_MESSAGES_URL=tcp://localhost:1883 \
MG_LORA_ADAPTER_MESSAGES_TOPIC=application/+/device/+/event/up \
MG_LORA_ADAPTER_MESSAGES_USER="" \
MG_LORA_ADAPTER_MESSAGES_PASS="" \
MG_LORA_ADAPTER_MESSAGES_TIMEOUT=30s \
MG_LORA_ADAPTER_ROUTE_MAP_URL=redis://localhost:6379 \
MG_ES_URL=nats://localhost:4222 \
MG_LORA_ADAPTER_EVENT_CONSUMER=lora-adapter \
MG_MESSAGE_BROKER_URL=nats://localhost:4222 \
MG_JAEGER_URL=http://localhost:14268/api/traces \
MG_JAEGER_TRACE_RATIO=1.0 \
MG_SEND_TELEMETRY=true \
MG_LORA_ADAPTER_INSTANCE_ID="" \
$GOBIN/magistrala-lora

Setting MG_LORA_ADAPTER_HTTP_SERVER_CERT and MG_LORA_ADAPTER_HTTP_SERVER_KEY will enable TLS against the service. The service expects a file in PEM format for both the certificate and the key.

Using docker-compose

This service can be deployed using docker containers. Docker compose file is available in <project_root>/docker/addons/lora-adapter/docker-compose.yml. In order to run Magistrala lora-adapter, execute the following command:

docker-compose -f docker/addons/lora-adapter/docker-compose.yml up -d

Usage

For more information about service capabilities and its usage, please check out the Magistrala documentation.

Documentation

Overview

Package lora contains the domain concept definitions needed to support Magistrala LoRa service functionality.

Index

Constants

This section is empty.

Variables

View Source 
var (
	// ErrMalformedMessage indicates malformed LoRa message.
	ErrMalformedMessage = errors.New("malformed message received")

	// ErrNotFoundDev indicates a non-existent route map for a device EUI.
	ErrNotFoundDev = errors.New("route map not found for this device EUI")

	// ErrNotFoundApp indicates a non-existent route map for an application ID.
	ErrNotFoundApp = errors.New("route map not found for this application ID")

	// ErrNotConnected indicates a non-existent route map for a connection.
	ErrNotConnected = errors.New("route map not found for this connection")
)

Functions

This section is empty.

Types

type DataRate 

type DataRate struct {
	Modulation   string  `json:"modulation"`
	Bandwidth    float64 `json:"bandwidth"`
	SpreadFactor int64   `json:"spreadFactor"`
}

DataRate lora data rate.

type Message 

type Message struct {
	ApplicationID       string      `json:"applicationID"`
	ApplicationName     string      `json:"applicationName"`
	DeviceName          string      `json:"deviceName"`
	DevEUI              string      `json:"devEUI"`
	DeviceStatusBattery string      `json:"deviceStatusBattery"`
	DeviceStatusMrgin   string      `json:"deviceStatusMargin"`
	RxInfo              RxInfo      `json:"rxInfo"`
	TxInfo              TxInfo      `json:"txInfo"`
	FCnt                int         `json:"fCnt"`
	FPort               int         `json:"fPort"`
	Data                string      `json:"data"`
	Object              interface{} `json:"object"`
}

Message lora msg (https://www.chirpstack.io/application-server/integrations/events).

type RouteMapRepository 

type RouteMapRepository interface {
	// Save stores/routes pair lora application topic & magistrala channel.
	Save(context.Context, string, string) error

	// Channel returns magistrala channel for given lora application.
	Get(context.Context, string) (string, error)

	// Removes mapping from cache.
	Remove(context.Context, string) error
}

RouteMapRepository store route map between Lora App Server and Magistrala.

type RxInfo 

type RxInfo []struct {
	Mac       string  `json:"mac"`
	Name      string  `json:"name"`
	Latitude  float64 `json:"latitude"`
	Longitude float64 `json:"longitude"`
	Altitude  float64 `json:"altitude"`
	Time      string  `json:"time"`
	Rssi      float64 `json:"rssi"`
	LoRaSNR   float64 `json:"loRaSNR"`
}

RxInfo receiver parameters.

type Service 

type Service interface {
	// CreateThing creates thingID:devEUI route-map
	CreateThing(ctx context.Context, thingID, devEUI string) error

	// UpdateThing updates thingID:devEUI route-map
	UpdateThing(ctx context.Context, thingID, devEUI string) error

	// RemoveThing removes thingID:devEUI route-map
	RemoveThing(ctx context.Context, thingID string) error

	// CreateChannel creates channelID:appID route-map
	CreateChannel(ctx context.Context, chanID, appID string) error

	// UpdateChannel updates channelID:appID route-map
	UpdateChannel(ctx context.Context, chanID, appID string) error

	// RemoveChannel removes channelID:appID route-map
	RemoveChannel(ctx context.Context, chanID string) error

	// ConnectThing creates thingID:channelID route-map
	ConnectThing(ctx context.Context, chanID, thingID string) error

	// DisconnectThing removes thingID:channelID route-map
	DisconnectThing(ctx context.Context, chanID, thingID string) error

	// Publish forwards messages from the LoRa MQTT broker to Magistrala Message Broker
	Publish(ctx context.Context, msg *Message) error
}

Service specifies an API that must be fullfiled by the domain service implementation, and all of its decorators (e.g. logging & metrics).

func New 

func New(publisher messaging.Publisher, thingsRM, channelsRM, connectRM RouteMapRepository) Service

New instantiates the LoRa adapter implementation.

type TxInfo 

type TxInfo struct {
	Frequency float64  `json:"frequency"`
	DataRate  DataRate `json:"dataRate"`
	Adr       bool     `json:"adr"`
	CodeRate  string   `json:"codeRate"`
}

TxInfo transmeter parameters.

Source Files

View all Source files

Directories

Path Synopsis
Package api contains API-related concerns: endpoint definitions, middlewares and all resource representations.
 Package api contains API-related concerns: endpoint definitions, middlewares and all resource representations.
Package events provides the domain concept definitions needed to support lora events functionality.
 Package events provides the domain concept definitions needed to support lora events functionality.
Package mocks contains mocks for testing purposes.
 Package mocks contains mocks for testing purposes.
Package mqtt contains the domain concept definitions needed to support Magistrala MQTT adapter functionality.
 Package mqtt contains the domain concept definitions needed to support Magistrala MQTT adapter functionality.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.