Update the ChirpStack Simulator for ChirpStack v4.

Author: brocaar

Dockerfile-devel

@@ -1,4 +1,4 @@
-FROM golang:1.13-alpine
+FROM golang:1.18-alpine
 
 ENV PROJECT_PATH=/chirpstack-simulator
 ENV PATH=$PATH:$PROJECT_PATH/build

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2020 Orne Brocaar
+Copyright (c) 2022 Orne Brocaar
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,7 +1,7 @@
 # ChirpStack Simulator
 
 ChirpStack Simulator is an open-source simulator for the [ChirpStack](https://www.chirpstack.io)
-open-source LoRaWAN<sup>&reg;</sup> Network-Server stack. It simulates
+open-source LoRaWAN<sup>&reg;</sup> Network-Server (v4). It simulates
 a configurable number of devices and gateways, which will be automatically
 created on starting the simulation.
 
@@ -36,8 +36,8 @@ For generating a configuration template, use the following command:
 log_level=4
 
 
-# Application Server configuration.
-[application_server]
+# ChirpStack configuration.
+[chirpstack]
 
   # API configuration.
   #
@@ -46,20 +46,18 @@ log_level=4
   #   * Gateways
   #   * Application
   #   * Devices
-  [application_server.api]
+  [chirpstack.api]
 
   # JWT token.
   #
-  # The JWT token to connect to the ChirpStack Application Server API. This
-  # token can be generated using the login API endpoint. In the near-future
-  # it will be possible to generate these tokens within the web-interface:
-  # https://github.com/brocaar/chirpstack-application-server/pull/421
-  jwt_token="PUT_YOUR_JWT_TOKEN_HERE"
+  # API key to connect to the ChirpStack API. This API key can created within
+  # the ChirpStack web-interface.
+  api_key="PUT_YOUR_API_KEY_HERE"
 
   # Server.
   #
-  # This must point to the external API server of the ChirpStack Application
-  # Server. When the server is running on the same machine, keep this to the
+  # This must point to the API interface of ChirpStack.
+  # If the server is running on the same machine, keep this to the
   # default value.
   server="127.0.0.1:8080"
 
@@ -72,8 +70,8 @@ log_level=4
   # MQTT integration configuration.
   #
   # This integration is used for counting the number of uplinks that are
-  # published by the ChirpStack Application Server integration.
-  [application_server.integration.mqtt]
+  # published by the ChirpStack MQTT integration.
+  [chirpstack.integration.mqtt]
 
   # MQTT server.
   server="tcp://127.0.0.1:1883"
@@ -85,14 +83,8 @@ log_level=4
   password=""
 
 
-# Network Server configuration.
-#
-# This configuration is used to simulate LoRa gateways using the MQTT gateway
-# backend.
-[network_server]
-
   # MQTT gateway backend.
-  [network_server.gateway.backend.mqtt]
+  [chirpstack.gateway.backend.mqtt]
 
   # MQTT server.
   server="tcp://127.0.0.1:1883"
@@ -107,11 +99,10 @@ log_level=4
 # Simulator configuration.
 [[simulator]]
 
-# Service-profile ID.
+# Tenant ID.
 #
-# It is recommended to create a new organization with a new service-profile
-# in the ChirpStack Application Server.
-service_profile_id="PUT_YOUR_SERVICE_PROFILE_ID_HERE"
+# It is recommended to create a new tenant for simulations.
+tenant_id="PUT_YOUR_TENANT_ID_HERE"
 
 # Duration.
 #
@@ -159,10 +150,10 @@ activation_time="1m"
   max_count=5
 
   # Event topic template.
-  event_topic_template="gateway/{{ .GatewayID }}/event/{{ .Event }}"
+  event_topic_template="eu868/gateway/{{ .GatewayID }}/event/{{ .Event }}"
 
   # Command topic template.
-  command_topic_template="gateway/{{ .GatewayID }}/command/{{ .Command }}"
+  command_topic_template="eu868/gateway/{{ .GatewayID }}/command/{{ .Command }}"
 
 
 # Prometheus metrics configuration.
@@ -173,7 +164,7 @@ activation_time="1m"
 #   * Join-Accepts received
 #   * Uplinks sent (by the devices)
 #   * Uplinks sent (by the gateways)
-#   * Uplinks sent (by the ChirpStack Application Server MQTT integration)
+#   * Uplinks sent (by the ChirpStack MQTT integration)
 [prometheus]
 
 # IP:port to bind the Prometheus endpoint to.

cmd/chirpstack-simulator/cmd/configfile.go

@@ -11,14 +11,14 @@ import (
 )
 
 const configTemplate = `[general]
-# Log level
-#
-# debug=5, info=4, warning=3, error=2, fatal=1, panic=0
-log_level={{ .General.LogLevel }}
+  # Log level
+  #
+  # debug=5, info=4, warning=3, error=2, fatal=1, panic=0
+  log_level={{ .General.LogLevel }}
 
 
-# Application Server configuration.
-[application_server]
+# ChirpStack configuration.
+[chirpstack]
 
   # API configuration.
   #
@@ -27,74 +27,62 @@ log_level={{ .General.LogLevel }}
   #   * Gateways
   #   * Application
   #   * Devices
-  [application_server.api]
-
-  # JWT token.
-  #
-  # The JWT token to connect to the ChirpStack Application Server API. This
-  # token can be generated using the login API endpoint. In the near-future
-  # it will be possible to generate these tokens within the web-interface:
-  # https://github.com/brocaar/chirpstack-application-server/pull/421
-  jwt_token="{{ .ApplicationServer.API.JWTToken }}"
+  [chirpstack.api]
 
-  # Server.
-  #
-  # This must point to the external API server of the ChirpStack Application
-  # Server. When the server is running on the same machine, keep this to the
-  # default value.
-  server="{{ .ApplicationServer.API.Server }}"
+    # API key.
+    #
+    # The API key can be obtained through the ChirpStack web-interface.
+    api_key="{{ .ChirpStack.API.APIKey }}"
 
-  # Insecure.
-  #
-  # Set this to true when the endpoint is not using TLS.
-  insecure={{ .ApplicationServer.API.Insecure }}
+    # Server.
+    #
+    # This must point to the ChirpStack API interface.
+    server="{{ .ChirpStack.API.Server }}"
 
+    # Insecure.
+    #
+    # Set this to true when the endpoint is not using TLS.
+    insecure={{ .ChirpStack.API.Insecure }}
 
-  # MQTT integration configuration.
-  #
-  # This integration is used for counting the number of uplinks that are
-  # published by the ChirpStack Application Server integration.
-  [application_server.integration.mqtt]
 
-  # MQTT server.
-  server="{{ .ApplicationServer.Integration.MQTT.Server }}"
+    # MQTT integration configuration.
+    #
+    # This integration is used for counting the number of uplinks that are
+    # published by the ChirpStack MQTT integration.
+    [chirpstack.integration.mqtt]
 
-  # Username.
-  username="{{ .ApplicationServer.Integration.MQTT.Username }}"
+    # MQTT server.
+    server="{{ .ChirpStack.Integration.MQTT.Server }}"
 
-  # Password.
-  password="{{ .ApplicationServer.Integration.MQTT.Password }}"
+    # Username.
+    username="{{ .ChirpStack.Integration.MQTT.Username }}"
 
+    # Password.
+    password="{{ .ChirpStack.Integration.MQTT.Password }}"
 
-# Network Server configuration.
-#
-# This configuration is used to simulate LoRa gateways using the MQTT gateway
-# backend.
-[network_server]
 
   # MQTT gateway backend.
-  [network_server.gateway.backend.mqtt]
+  [chirpstack.gateway.backend.mqtt]
 
-  # MQTT server.
-  server="{{ .NetworkServer.Gateway.Backend.MQTT.Server }}"
+    # MQTT server.
+    server="{{ .NetworkServer.Gateway.Backend.MQTT.Server }}"
 
-  # Username.
-  username="{{ .NetworkServer.Gateway.Backend.MQTT.Username }}"
+    # Username.
+    username="{{ .NetworkServer.Gateway.Backend.MQTT.Username }}"
 
-  # Password.
-  password="{{ .NetworkServer.Gateway.Backend.MQTT.Password }}"
+    # Password.
+    password="{{ .NetworkServer.Gateway.Backend.MQTT.Password }}"
 
 
 # Simulator configuration.
 #
 # Example:
 # [[simulator]]
 #
-# # Service-profile ID.
+# # Tenant ID.
 # #
-# # It is recommended to create a new organization with a new service-profile
-# # in the ChirpStack Application Server.
-# service_profile_id="1f32476e-a112-4f00-bcc7-4aab4bfefa1d"
+# # It is recommended to create a new tenant in ChirpStack.
+# tenant_id="1f32476e-a112-4f00-bcc7-4aab4bfefa1d"
 #
 # # Duration.
 # #
@@ -136,10 +124,10 @@ log_level={{ .General.LogLevel }}
 #   [simulator.gateway]
 #
 #   # Event topic template.
-#   event_topic_template="{{ "gateway/{{ .GatewayID }}/event/{{ .Event }}" }}"
+#   event_topic_template="eu868/{{ "gateway/{{ .GatewayID }}/event/{{ .Event }}" }}"
 #
 #   # Command topic template.
-#   command_topic_template="{{ "gateway/{{ .GatewayID }}/command/{{ .Command }}" }}"
+#   command_topic_template="eu868/{{ "gateway/{{ .GatewayID }}/command/{{ .Command }}" }}"
 #
 #   # Min number of receiving gateways.
 #   min_count=3

examples/single_uplink/main.go

@@ -6,10 +6,9 @@ import (
 	"sync"
 	"time"
 
-	"github.com/brocaar/chirpstack-api/go/v3/common"
-	"github.com/brocaar/chirpstack-api/go/v3/gw"
 	"github.com/brocaar/chirpstack-simulator/simulator"
 	"github.com/brocaar/lorawan"
+	"github.com/chirpstack/chirpstack/api/go/v4/gw"
 	log "github.com/sirupsen/logrus"
 )
 
@@ -26,8 +25,8 @@ func main() {
 	sgw, err := simulator.NewGateway(
 		simulator.WithMQTTCredentials("localhost:1883", "", ""),
 		simulator.WithGatewayID(gatewayID),
-		simulator.WithEventTopicTemplate("gateway/{{ .GatewayID }}/event/{{ .Event }}"),
-		simulator.WithCommandTopicTemplate("gateway/{{ .GatewayID }}/command/{{ .Command }}"),
+		simulator.WithEventTopicTemplate("eu868/gateway/{{ .GatewayID }}/event/{{ .Event }}"),
+		simulator.WithCommandTopicTemplate("eu868/gateway/{{ .GatewayID }}/command/{{ .Command }}"),
 	)
 	if err != nil {
 		panic(err)
@@ -40,14 +39,15 @@ func main() {
 		simulator.WithUplinkInterval(time.Second),
 		simulator.WithUplinkCount(1),
 		simulator.WithUplinkPayload(true, 10, []byte{1, 2, 3}),
-		simulator.WithUplinkTXInfo(gw.UplinkTXInfo{
-			Frequency:  868100000,
-			Modulation: common.Modulation_LORA,
-			ModulationInfo: &gw.UplinkTXInfo_LoraModulationInfo{
-				LoraModulationInfo: &gw.LoRaModulationInfo{
-					Bandwidth:       125,
-					SpreadingFactor: 7,
-					CodeRate:        "3/4",
+		simulator.WithUplinkTXInfo(gw.UplinkTxInfo{
+			Frequency: 868100000,
+			Modulation: &gw.Modulation{
+				Parameters: &gw.Modulation_Lora{
+					Lora: &gw.LoraModulationInfo{
+						Bandwidth:       125000,
+						SpreadingFactor: 7,
+						CodeRate:        gw.CodeRate_CR_4_6,
+					},
 				},
 			},
 		}),

go.mod

@@ -3,19 +3,17 @@ module github.com/brocaar/chirpstack-simulator
 go 1.13
 
 require (
-	github.com/brocaar/chirpstack-api/go/v3 v3.1.3
 	github.com/brocaar/lorawan v0.0.0-20191105091820-9ed596703a6c
+	github.com/chirpstack/chirpstack/api/go/v4 v4.0.0-rc.2
 	github.com/eclipse/paho.mqtt.golang v1.2.0
 	github.com/gofrs/uuid v3.2.0+incompatible
-	github.com/golang/protobuf v1.3.2
+	github.com/golang/protobuf v1.5.2
 	github.com/pkg/errors v0.8.1
 	github.com/prometheus/client_golang v0.9.3
 	github.com/sirupsen/logrus v1.4.2
 	github.com/smartystreets/assertions v1.0.0 // indirect
 	github.com/spf13/cobra v0.0.5
 	github.com/spf13/viper v1.5.0
-	golang.org/x/net v0.0.0-20190620200207-3b0461eec859 // indirect
-	golang.org/x/sys v0.0.0-20190507160741-ecd444e8653b // indirect
 	golang.org/x/text v0.3.2 // indirect
-	google.golang.org/grpc v1.26.0
+	google.golang.org/grpc v1.45.0
 )