frequencyplans.go

// Copyright © 2019 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 test

import (
	"go.thethings.network/lorawan-stack/v3/pkg/fetch"
	"go.thethings.network/lorawan-stack/v3/pkg/frequencyplans"
)

const (
	frequencyPlansDescription = `- id: EU_863_870
  name: Europe 863-870 MHz
  base-frequency: 868
  file: EU_863_870.yml
- id: KR_920_923
  name: Korea 920-923 MHz
  base-frequency: 915
  file: KR_920_923.yml
- id: US_902_928_FSB_2
  name: US 902-928 MHz FSB2
  base-frequency: 915
  file: US_902_928_FSB_2.yml
- id: AS_923_925_AU
  name: Australia 923-925 MHz (AS923)
  base-frequency: 915
  file: AS_923_925_AU.yml
- id: AU_915_928_FSB_2
  name: Australia 915-928 MHz, FSB 2 (used by TTN)
  base-frequency: 915
  file: AU_915_928_FSB_2.yml
- id: EXAMPLE
  name: Example 866.1 MHz
  base-frequency: 868
  file: EXAMPLE.yml`

	// EUFrequencyPlanID is a European frequency plan for testing.
	EUFrequencyPlanID = "EU_863_870"
	euFrequencyPlan   = `band-id: EU_863_870
uplink-channels:
- frequency: 868100000
  min-data-rate: 0
  max-data-rate: 5
- frequency: 868300000
  min-data-rate: 0
  max-data-rate: 5
- frequency: 868500000
  min-data-rate: 0
  max-data-rate: 5
- frequency: 867100000
  min-data-rate: 0
  max-data-rate: 5
- frequency: 867300000
  min-data-rate: 0
  max-data-rate: 5
- frequency: 867500000
  min-data-rate: 0
  max-data-rate: 5
- frequency: 867700000
  min-data-rate: 0
  max-data-rate: 5
- frequency: 867900000
  min-data-rate: 0
  max-data-rate: 5
downlink-channels:
- frequency: 868100000
  min-data-rate: 0
  max-data-rate: 5
- frequency: 868300000
  min-data-rate: 0
  max-data-rate: 5
- frequency: 868500000
  min-data-rate: 0
  max-data-rate: 5
- frequency: 867100000
  min-data-rate: 0
  max-data-rate: 5
- frequency: 867300000
  min-data-rate: 0
  max-data-rate: 5
- frequency: 867500000
  min-data-rate: 0
  max-data-rate: 5
- frequency: 867700000
  min-data-rate: 0
  max-data-rate: 5
- frequency: 867900000
  min-data-rate: 0
  max-data-rate: 5
lora-standard-channel:
  frequency: 868300000
  data-rate: 6
fsk-channel:
  frequency: 868800000
  data-rate: 7
radios:
- enable: true
  chip-type: SX1257
  frequency: 867500000
  rssi-offset: -166
  tx:
    min-frequency: 863000000
    max-frequency: 870000000
- enable: true
  chip-type: SX1257
  frequency: 868500000
  rssi-offset: -166
clock-source: 1
`

	// KRFrequencyPlanID is a Korean frequency plan for testing.
	KRFrequencyPlanID = "KR_920_923"
	krFrequencyPlan   = `band-id: KR_920_923
uplink-channels:
- frequency: 922100000
  min-data-rate: 0
  max-data-rate: 5
- frequency: 922300000
  min-data-rate: 0
  max-data-rate: 5
- frequency: 922500000
  min-data-rate: 0
  max-data-rate: 5
- frequency: 922700000
  min-data-rate: 0
  max-data-rate: 5
- frequency: 922900000
  min-data-rate: 0
  max-data-rate: 5
- frequency: 923100000
  min-data-rate: 0
  max-data-rate: 5
- frequency: 923300000
  min-data-rate: 0
  max-data-rate: 5
downlink-channels:
- frequency: 922100000
  min-data-rate: 0
  max-data-rate: 5
- frequency: 922300000
  min-data-rate: 0
  max-data-rate: 5
- frequency: 922500000
  min-data-rate: 0
  max-data-rate: 5
- frequency: 922700000
  min-data-rate: 0
  max-data-rate: 5
- frequency: 922900000
  min-data-rate: 0
  max-data-rate: 5
- frequency: 923100000
  min-data-rate: 0
  max-data-rate: 5
- frequency: 923300000
  min-data-rate: 0
  max-data-rate: 5
radios:
- enable: true
  chip-type: SX1257
  frequency: 922400000
  rssi-offset: -166
  tx:
    min-frequency: 920900000
    max-frequency: 923300000
- enable: true
  chip-type: SX1257
  frequency: 923000000
  rssi-offset: -166
clock-source: 1
lbt:
  rssi-target: -80
  scan-time: 128`

	// USFrequencyPlanID is a American frequency plan for testing.
	USFrequencyPlanID = "US_902_928_FSB_2"
	usFrequencyPlan   = `band-id: US_902_928
uplink-channels:
- frequency: 903900000
  min-data-rate: 0
  max-data-rate: 3
  radio: 0
- frequency: 904100000
  min-data-rate: 0
  max-data-rate: 3
  radio: 0
- frequency: 904300000
  min-data-rate: 0
  max-data-rate: 3
  radio: 0
- frequency: 904500000
  min-data-rate: 0
  max-data-rate: 3
  radio: 0
- frequency: 904700000
  min-data-rate: 0
  max-data-rate: 3
  radio: 1
- frequency: 904900000
  min-data-rate: 0
  max-data-rate: 3
  radio: 1
- frequency: 905100000
  min-data-rate: 0
  max-data-rate: 3
  radio: 1
- frequency: 905300000
  min-data-rate: 0
  max-data-rate: 3
  radio: 1
downlink-channels:
- frequency: 923300000
  min-data-rate: 8
  max-data-rate: 13
- frequency: 923900000
  min-data-rate: 8
  max-data-rate: 13
- frequency: 924500000
  min-data-rate: 8
  max-data-rate: 13
- frequency: 925100000
  min-data-rate: 8
  max-data-rate: 13
- frequency: 925700000
  min-data-rate: 8
  max-data-rate: 13
- frequency: 926300000
  min-data-rate: 8
  max-data-rate: 13
- frequency: 926900000
  min-data-rate: 8
  max-data-rate: 13
- frequency: 927500000
  min-data-rate: 8
  max-data-rate: 13
lora-standard-channel:
  frequency: 904600000
  data-rate: 4
  radio: 0
dwell-time:
  uplinks: true
  downlinks: false
  duration: 400ms
radios:
- enable: true
  chip-type: SX1257
  frequency: 904300000
  rssi-offset: -166
  tx:
    min-frequency: 923000000
    max-frequency: 928000000
- enable: true
  chip-type: SX1257
  frequency: 905000000
  rssi-offset: -166
clock-source: 1`

	// ASAUFrequencyPlanID is an AS923 for Australia frequency plan for testing.
	ASAUFrequencyPlanID = "AS_923_925_AU"
	asAUFrequencyPlan   = `band-id: AS_923
sub-bands:
- min-frequency: 915000000
  max-frequency: 928000000
dwell-time:
  uplinks: false
  downlinks: false
max-eirp: 30
uplink-channels:
- frequency: 923200000
  min-data-rate: 0
  max-data-rate: 5
  radio: 0
- frequency: 923400000
  min-data-rate: 0
  max-data-rate: 5
  radio: 0
- frequency: 923600000
  min-data-rate: 0
  max-data-rate: 5
  radio: 0
- frequency: 923800000
  min-data-rate: 0
  max-data-rate: 5
  radio: 0
- frequency: 924000000
  min-data-rate: 0
  max-data-rate: 5
  radio: 0
- frequency: 924200000
  min-data-rate: 0
  max-data-rate: 5
  radio: 1
- frequency: 924400000
  min-data-rate: 0
  max-data-rate: 5
  radio: 1
- frequency: 924600000
  min-data-rate: 0
  max-data-rate: 5
  radio: 1
downlink-channels:
- frequency: 923200000
  min-data-rate: 0
  max-data-rate: 5
- frequency: 923400000
  min-data-rate: 0
  max-data-rate: 5
- frequency: 923600000
  min-data-rate: 0
  max-data-rate: 5
- frequency: 923800000
  min-data-rate: 0
  max-data-rate: 5
- frequency: 924000000
  min-data-rate: 0
  max-data-rate: 5
- frequency: 924200000
  min-data-rate: 0
  max-data-rate: 5
- frequency: 924400000
  min-data-rate: 0
  max-data-rate: 5
- frequency: 924600000
  min-data-rate: 0
  max-data-rate: 5
lora-standard-channel:
  frequency: 924500000
  data-rate: 6
  radio: 1
fsk-channel:
  frequency: 924800000
  data-rate: 7
  radio: 1
radios:
- enable: true
  chip-type: SX1257
  frequency: 923600000
  rssi-offset: -166
  tx:
    min-frequency: 923200000
    max-frequency: 925000000
- enable: true
  chip-type: SX1257
  frequency: 924600000
  rssi-offset: -166
clock-source: 1`

	// AUFrequencyPlanID is the identifier of the Australia 915-928 FSB 2 frequency plan.
	AUFrequencyPlanID = "AU_915_928_FSB_2"
	auFrequencyPlan   = `band-id: AU_915_928
uplink-channels:
- frequency: 916800000
  min-data-rate: 0
  max-data-rate: 5
  radio: 0
- frequency: 917000000
  min-data-rate: 0
  max-data-rate: 5
  radio: 0
- frequency: 917200000
  min-data-rate: 0
  max-data-rate: 5
  radio: 0
- frequency: 917400000
  min-data-rate: 0
  max-data-rate: 5
  radio: 0
- frequency: 917600000
  min-data-rate: 0
  max-data-rate: 5
  radio: 1
- frequency: 917800000
  min-data-rate: 0
  max-data-rate: 5
  radio: 1
- frequency: 918000000
  min-data-rate: 0
  max-data-rate: 5
  radio: 1
- frequency: 918200000
  min-data-rate: 0
  max-data-rate: 5
  radio: 1
lora-standard-channel:
  frequency: 917500000
  data-rate: 6
  radio: 0
radios:
- enable: true
  chip-type: SX1257
  frequency: 917200000
  rssi-offset: -166
  tx:
    min-frequency: 915000000
    max-frequency: 928000000
- enable: true
  chip-type: SX1257
  frequency: 917900000
  rssi-offset: -166
clock-source: 1`

	// ExampleFrequencyPlanID is an example frequency plan.
	ExampleFrequencyPlanID = "EXAMPLE"
	exampleFrequencyPlan   = `band-id: EU_863_870
uplink-channels:
- frequency: 868100000
  min-data-rate: 0
  max-data-rate: 5
  radio: 0
downlink-channels:
- frequency: 868100000
  min-data-rate: 0
  max-data-rate: 5
  radio: 0
lora-standard-channel:
  frequency: 863000000
  data-rate: 6
fsk-channel:
  frequency: 868800000
  data-rate: 7
time-off-air:
  fraction: 0.1
  duration: 1s
dwell-time:
  uplinks: true
  downlinks: true
  duration: 1s
lbt:
  rssi-offset: 0
  rssi-target: -80
  scan-time: 128000
radios:
- enable: true
  chip-type: SX1257
  frequency: 867500000
  rssi-offset: -166
  tx:
    min-frequency: 863000000
    max-frequency: 867000000
    notch-frequency: 129000
clock-source: 0
ping-slot:
  frequency: 869525000
  min-data-rate: 0
  max-data-rate: 5
  radio: 0
ping-slot-default-data-rate: 3
rx2-channel:
  frequency: 869525000
  min-data-rate: 0
  max-data-rate: 5
  radio: 0
rx2-default-data-rate: 0
max-eirp: 27`
)

var (
	// StaticFrequencyPlans contains the values used to mock a static
	// frequencyStore in most tests component related
	StaticFrequencyPlans = map[string][]byte{
		"frequency-plans.yml":  []byte(frequencyPlansDescription),
		"EU_863_870.yml":       []byte(euFrequencyPlan),
		"KR_920_923.yml":       []byte(krFrequencyPlan),
		"US_902_928_FSB_2.yml": []byte(usFrequencyPlan),
		"AS_923_925_AU.yml":    []byte(asAUFrequencyPlan),
		"AU_915_928_FSB_2.yml": []byte(auFrequencyPlan),
		"EXAMPLE.yml":          []byte(exampleFrequencyPlan),
	}

	// FrequencyPlansFetcher fetches frequency plans from memory.
	FrequencyPlansFetcher = fetch.NewMemFetcher(StaticFrequencyPlans)

	FrequencyPlanStore = frequencyplans.NewStore(FrequencyPlansFetcher)
)

func FrequencyPlan(id string) *frequencyplans.FrequencyPlan {
	return Must(FrequencyPlanStore.GetByID(id))
}