Support migration from Loriot

cmd/loriot/loriot.go

@@ -0,0 +1,21 @@
+// Copyright © 2023 The Things Network Foundation, The Things Industries B.V.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package loriot
+
+import "go.thethings.network/lorawan-stack-migrate/pkg/commands"
+
+const sourceName = "loriot"
+
+var LoriotCmd = commands.Source(sourceName, "Export devices from Loriot")

cmd/root.go

@@ -20,6 +20,7 @@ import (
 
 	"github.com/spf13/cobra"
 	"go.thethings.network/lorawan-stack-migrate/cmd/chirpstack"
+	"go.thethings.network/lorawan-stack-migrate/cmd/loriot"
 	"go.thethings.network/lorawan-stack-migrate/cmd/ttnv2"
 	"go.thethings.network/lorawan-stack-migrate/cmd/tts"
 	"go.thethings.network/lorawan-stack-migrate/pkg/export"
@@ -92,7 +93,8 @@ func init() {
 		Title: "Sources:",
 	})
 
+	rootCmd.AddCommand(chirpstack.ChirpStackCmd)
+	rootCmd.AddCommand(loriot.LoriotCmd)
 	rootCmd.AddCommand(ttnv2.TTNv2Cmd)
 	rootCmd.AddCommand(tts.TTSCmd)
-	rootCmd.AddCommand(chirpstack.ChirpStackCmd)
 }

cmd/ttn-lw-migrate/main.go

@@ -18,6 +18,7 @@ import (
 	"os"
 
 	_ "go.thethings.network/lorawan-stack-migrate/pkg/source/chirpstack" // ChirpStack source
+	_ "go.thethings.network/lorawan-stack-migrate/pkg/source/loriot"     // LorIoT source
 	_ "go.thethings.network/lorawan-stack-migrate/pkg/source/ttnv2"      // TTNv2 source
 	_ "go.thethings.network/lorawan-stack-migrate/pkg/source/tts"        // TTS source
 

pkg/source/loriot/api/api.go

@@ -0,0 +1,169 @@
+// Copyright © 2023 The Things Network Foundation, The Things Industries B.V.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package api
+
+import (
+	"encoding/json"
+	"fmt"
+	"io"
+	"io/ioutil"
+	"net/http"
+	"strings"
+	"time"
+)
+
+var (
+	urlPrefix = "https://"
+	apiURL    string
+	apiKey    string
+
+	client = &http.Client{Timeout: 10 * time.Second}
+)
+
+func SetURLPrefix(insecure bool) {
+	if insecure {
+		urlPrefix = "http://"
+		return
+	}
+	urlPrefix = "https://"
+}
+
+func SetAPIURL(url string) {
+	if s := strings.Split(url, "://"); len(s) > 1 {
+		url = strings.Join(s[1:], "")
+	}
+	apiURL = url
+}
+
+func SetAPIKey(key string) {
+	apiKey = key
+}
+
+func NewRequest(method, path string, body io.Reader) (*http.Request, error) {
+	switch {
+	case apiURL == "":
+		return nil, errNoAPIURL.New()
+
+	case apiKey == "":
+		return nil, errNoAPIKey.New()
+	}
+
+	req, err := http.NewRequest(method, urlPrefix+apiURL+path, body)
+	if err != nil {
+		return nil, err
+	}
+	req.Header.Set("Authorization", "Bearer "+apiKey)
+	return req, nil
+}
+
+type Device struct {
+	ID                string   `json:"_id"`
+	Devaddr           string   `json:"devaddr"`
+	Seqno             int      `json:"seqno"`
+	Seqdn             int      `json:"seqdn"`
+	Seqq              int      `json:"seqq"`
+	AdrCnt            int      `json:"adrCnt"`
+	Subscription      int      `json:"subscription"`
+	Txrate            int      `json:"txrate"`
+	Rxrate            int      `json:"rxrate"`
+	Devclass          string   `json:"devclass"`
+	Rxw               int      `json:"rxw"`
+	Dutycycle         int      `json:"dutycycle"`
+	Adr               bool     `json:"adr"`
+	AdrMin            int      `json:"adrMin"`
+	AdrMax            int      `json:"adrMax"`
+	AdrFix            int      `json:"adrFix"`
+	AdrCntLimit       int      `json:"adrCntLimit"`
+	Seqrelax          bool     `json:"seqrelax"`
+	Seqdnreset        bool     `json:"seqdnreset"`
+	Nonce             int      `json:"nonce"`
+	LastJoin          string   `json:"lastJoin"`
+	LastSeen          int      `json:"lastSeen"`
+	Rssi              float64  `json:"rssi"`
+	Snr               float64  `json:"snr"`
+	Freq              int      `json:"freq"`
+	Sf                int      `json:"sf"`
+	Bw                int      `json:"bw"`
+	Gw                string   `json:"gw"`
+	Appeui            string   `json:"appeui"`
+	LastDevStatusSeen string   `json:"lastDevStatusSeen"`
+	Bat               int      `json:"bat"`
+	DevSnr            int      `json:"devSnr"`
+	Lorawan           *Lorawan `json:"lorawan"`
+}
+
+type Lorawan struct {
+	Major    int    `json:"major"`
+	Minor    int    `json:"minor"`
+	Revision string `json:"revision"`
+}
+
+func GetDevice(appID, devEUI string) (*Device, error) {
+	d := new(Device)
+
+	req, err := NewRequest("GET", fmt.Sprintf("/app/%s/device/%s", appID, devEUI), nil)
+	if err != nil {
+		return nil, err
+	}
+
+	resp, err := client.Do(req)
+	if err != nil {
+		return nil, err
+	}
+	defer resp.Body.Close()
+
+	body, err := ioutil.ReadAll(resp.Body)
+	if err != nil {
+		return nil, err
+	}
+
+	return d, json.Unmarshal(body, d)
+}
+
+type PaginatedDevices struct {
+	Page    int      `json:"page"`
+	PerPage int      `json:"perPage"`
+	Total   int      `json:"total"`
+	Devices []Device `json:"apps"`
+}
+
+func GetPaginatedDevices(appID string, page int) (*PaginatedDevices, error) {
+	req, err := NewRequest("GET", fmt.Sprintf("/app/%s/devices?page=%d", appID, page), nil)
+	if err != nil {
+		return nil, err
+	}
+
+	resp, err := client.Do(req)
+	if err != nil {
+		return nil, err
+	}
+	defer resp.Body.Close()
+
+	if sc := resp.StatusCode; sc < 200 || sc >= 300 {
+		return nil, errInvalidStatusCode.WithAttributes("code", sc)
+	}
+
+	body, err := ioutil.ReadAll(resp.Body)
+	if err != nil {
+		return nil, err
+	}
+
+	r := new(PaginatedDevices)
+	if err := json.Unmarshal(body, r); err != nil {
+		return nil, err
+	}
+
+	return r, nil
+}

pkg/source/loriot/config/config.go

@@ -0,0 +1,57 @@
+// Copyright © 2023 The Things Network Foundation, The Things Industries B.V.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package config
+
+import (
+	"os"
+
+	"github.com/spf13/pflag"
+
+	"go.thethings.network/lorawan-stack-migrate/pkg/source"
+)
+
+func New() (*Config, *pflag.FlagSet) {
+	var (
+		cfg   = new(Config)
+		flags = new(pflag.FlagSet)
+	)
+
+	flags.StringVar(&cfg.APIKey,
+		"api-key",
+		os.Getenv("LORIOT_API_KEY"),
+		"Loriot API Key")
+	flags.StringVar(&cfg.URL, "api-url",
+		os.Getenv("LORIOT_API_URL"),
+		"Loriot API URL")
+	flags.StringVar(&cfg.AppID,
+		"app-id",
+		os.Getenv("LORIOT_APP_ID"),
+		"Loriot APP ID")
+	flags.BoolVar(&cfg.Insecure,
+		"insecure",
+		os.Getenv("LORIOT_INSECURE") == "1",
+		"Do not connect to Loriot over TLS")
+
+	return cfg, flags
+}
+
+type Config struct {
+	source.Config
+
+	APIKey, URL string
+	Insecure    bool
+
+	AppID string
+}

pkg/source/loriot/loriot.go

@@ -0,0 +1,31 @@
+// Copyright © 2023 The Things Network Foundation, The Things Industries B.V.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package loriot
+
+import (
+	"go.thethings.network/lorawan-stack-migrate/pkg/source"
+	"go.thethings.network/lorawan-stack-migrate/pkg/source/loriot/config"
+)
+
+func init() {
+	cfg, flags := config.New()
+
+	source.RegisterSource(source.Registration{
+		Name:        "loriot",
+		Description: "Migrate from Loriot LoRaWAN Network Server",
+		FlagSet:     flags,
+		Create:      createNewSource(cfg),
+	})
+}