README
¶
LoRa Adapter
Adapter between Mainflux IoT system and LoRa Server.
This adapter sits between Mainflux 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 Mainflux, where it is persisted and routed to other protocols via Mainflux multi-protocol message broker. Mainflux 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 |
|---|---|---|
| MF_LORA_ADAPTER_HTTP_PORT | Service HTTP port | 8180 |
| MF_LORA_ADAPTER_LOG_LEVEL | Service Log level | error |
| MF_BROKER_URL | Message broker instance URL | nats://localhost:4222 |
| MF_LORA_ADAPTER_MESSAGES_URL | LoRa adapter MQTT broker URL | tcp://localhost:1883 |
| MF_LORA_ADAPTER_MESSAGES_TOPIC | LoRa adapter MQTT subscriber Topic | application/+/device/+/event/up |
| MF_LORA_ADAPTER_MESSAGES_USER | LoRa adapter MQTT subscriber Username | |
| MF_LORA_ADAPTER_MESSAGES_PASS | LoRa adapter MQTT subscriber Password | |
| MF_LORA_ADAPTER_MESSAGES_TIMEOUT | LoRa adapter MQTT subscriber Timeout | 30s |
| MF_LORA_ADAPTER_ROUTE_MAP_URL | Route-map database URL | localhost:6379 |
| MF_LORA_ADAPTER_ROUTE_MAP_PASS | Route-map database password | |
| MF_LORA_ADAPTER_ROUTE_MAP_DB | Route-map instance | 0 |
| MF_THINGS_ES_URL | Things service event source URL | localhost:6379 |
| MF_THINGS_ES_PASS | Things service event source password | |
| MF_THINGS_ES_DB | Things service event source DB | 0 |
| MF_LORA_ADAPTER_EVENT_CONSUMER | Service event consumer name | lora |
Deployment
The service itself is distributed as Docker container. Check the lora-adapter service section in
docker-compose to see how service is deployed.
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/MainfluxLabs/mainflux
cd mainflux
# compile the lora adapter
make lora
# copy binary to bin
make install
# set the environment variables and run the service
MF_LORA_ADAPTER_LOG_LEVEL=[Lora Adapter Log Level] \
MF_BROKER_URL=[Message broker instance URL] \
MF_LORA_ADAPTER_MESSAGES_URL=[LoRa adapter MQTT broker URL] \
MF_LORA_ADAPTER_MESSAGES_TOPIC=[LoRa adapter MQTT subscriber Topic] \
MF_LORA_ADAPTER_MESSAGES_USER=[LoRa adapter MQTT subscriber Username] \
MF_LORA_ADAPTER_MESSAGES_PASS=[LoRa adapter MQTT subscriber Password] \
MF_LORA_ADAPTER_MESSAGES_TIMEOUT=[LoRa adapter MQTT subscriber Timeout]
MF_LORA_ADAPTER_ROUTE_MAP_URL=[Lora adapter routemap URL] \
MF_LORA_ADAPTER_ROUTE_MAP_PASS=[Lora adapter routemap password] \
MF_LORA_ADAPTER_ROUTE_MAP_DB=[Lora adapter routemap instance] \
MF_THINGS_ES_URL=[Things service event source URL] \
MF_THINGS_ES_PASS=[Things service event source password] \
MF_THINGS_ES_DB=[Things service event source password] \
MF_OPCUA_ADAPTER_EVENT_CONSUMER=[LoRa adapter instance name] \
$GOBIN/mainfluxlabs-lora
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 Mainflux 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 Mainflux documentation.
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
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"`
Bandwith float64 `json:"bandwith"`
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 & mainflux channel.
Save(context.Context, string, string) error
// Channel returns mainflux 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 Mainflux
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 string, devEUI string) error
// UpdateThing updates thingID:devEUI route-map
UpdateThing(ctx context.Context, thingID string, 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 string, appID string) error
// UpdateChannel updates channelID:appID route-map
UpdateChannel(ctx context.Context, chanID string, 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 Mainflux 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).
Source Files
Directories