Convert existing plans to new structure

README.md

@@ -20,7 +20,7 @@ sub-bands:
   max-eirp: 16.15               # Maximum EIRP for this sub-band (optional; takes precedence over frequency plan's max-eirp)
 channels:                       # List of  channels (zero indexed)
 - uplink-frequency: 868100000   # Uplink frequency (Hz)
-  downlink-frequency: 868100000 # Downlink frequency (Hz) (optional)
+  downlink-frequency: 868100000 # Downlink frequency (Hz)
   min-data-rate: SF7BW125       # Minimum data rate
   max-data-rate: SF11BW125      # Maximum data rate
   radio: 0                      # Radio index (see below)
@@ -159,6 +159,8 @@ There are json schemas available for all configuration files. These define files
 }
 ```
 
+Make sure to run `go run . -schema -docs` after changes or additions to the frequency plans. This ensures that the schemas and documentation stay up to date.
+
 ### Local Regulations
 
 When submitting a new frequency plan or making changes to an existing frequency plan, please make sure that the band is allowed to be used in the concerning region and that settings respect regional regulations. When submitting a pull request for a new region, please upload or link to a document that describes the local regulations.

docs/frequency-plans.md

@@ -9,18 +9,67 @@
 ![EU_863_870](images/end-device/EU_863_870.svg)
 
 ## `EU_863_870_TTN`: Europe 863-870 MHz
-Based on [EU_863_870](##EU_863_870) and modified by [rx2_default_data_rata_3.yml](../end-device/modifiers/rx2_default_data_rata_3.yml)
-
+Based on [EU_863_870](##EU_863_870) and modified by [rx2_default_data_rata_3.yml](../end-device/modifiers/rx2_default_data_rata_3.yml) 
 
 >> TTN Community Network frequency plan for Europe, using SF9 for RX2
 
 ![EU_863_870_TTN](images/end-device/EU_863_870_TTN.svg)
 
-# Gateway frequency plans
+## [`EU_863_870_ROAMING_DRAFT`](../end-device/EU_863_870_ROAMING_DRAFT.yml): Europe 863-870 MHz, 6 channels for roaming (Draft) 
+
+>> European 6 channel plan used by major operators to support LoRaWAN Passive Roaming
+
+![EU_863_870_ROAMING_DRAFT](images/end-device/EU_863_870_ROAMING_DRAFT.svg)
+
+## [`EU_433`](../end-device/EU_433.yml): Europe 433 MHz (ITU region 1) 
+
+>> Default frequency plan for worldwide 433MHz
+
+![EU_433](images/end-device/EU_433.svg)
+
+## [`US_902_928_FSB_1`](../end-device/US_902_928_FSB_1.yml): United States 902-928 MHz, FSB 1 
+
+>> Default frequency plan for the United States and Canada, using sub-band 1
+
+![US_902_928_FSB_1](images/end-device/US_902_928_FSB_1.svg)
+
+## [`AS_920_923`](../end-device/AS_920_923.yml): Asia 920-923 MHz 
+
+>> TTN Community Network frequency plan for Asian countries, using frequencies ≤ 923 MHz
+
+![AS_920_923](images/end-device/AS_920_923.svg)
+
+## `AS_920_923_LBT`: Asia 920-923 MHz with LBT
+Based on [AS_920_923](##AS_920_923) and modified by [lbt_80_over_128.yml](../end-device/modifiers/lbt_80_over_128.yml) 
 
+>> TTN Community Network frequency plan for Asian countries, using frequencies ≤ 923 MHz with listen-before-talk
+
+![AS_920_923_LBT](images/end-device/AS_920_923_LBT.svg)
+
+# Gateway frequency plans
 
 ## [`EU_863_870`](../gateway/EU_863_870.yml): Europe 863-870 MHz 
 
 >> Default frequency plan for Europe
 
 ![EU_863_870](images/gateway/EU_863_870.svg)
+
+## [`EU_433`](../gateway/EU_433.yml): Europe 433 MHz (ITU region 1) 
+
+>> Default frequency plan for worldwide 433MHz
+
+![EU_433](images/gateway/EU_433.svg)
+
+## [`AS_920_923`](../gateway/AS_920_923.yml): Asia 920-923 MHz 
+
+>> TTN Community Network frequency plan for Asian countries, using frequencies ≤ 923 MHz
+
+![AS_920_923](images/gateway/AS_920_923.svg)
+
+## `AS_920_923_LBT`: Asia 920-923 MHz with LBT
+Based on AS_920_923 and modified by [lbt_80_over_128.yml](../gateway/modifiers/lbt_80_over_128.yml)
+
+
+>> TTN Community Network frequency plan for Asian countries, using frequencies ≤ 923 MHz with listen-before-talk
+
+![AS_920_923_LBT](images/gateway/AS_920_923_LBT.svg)

end-device/AS_920_923.yml

@@ -0,0 +1,43 @@
+band-id: AS_923
+sub-bands:
+- min-frequency: 922000000
+  max-frequency: 923400000
+channels:
+- uplink-frequency: 923200000
+  downlink-frequency: 923200000
+  min-data-rate: 0
+  max-data-rate: 5
+- uplink-frequency: 923400000
+  downlink-frequency: 923400000
+  min-data-rate: 0
+  max-data-rate: 5
+- uplink-frequency: 922200000
+  downlink-frequency: 922200000
+  min-data-rate: 0
+  max-data-rate: 5
+- uplink-frequency: 922400000
+  downlink-frequency: 922400000
+  min-data-rate: 0
+  max-data-rate: 5
+- uplink-frequency: 922600000
+  downlink-frequency: 922600000
+  min-data-rate: 0
+  max-data-rate: 5
+- uplink-frequency: 922800000
+  downlink-frequency: 922800000
+  min-data-rate: 0
+  max-data-rate: 5
+- uplink-frequency: 923000000
+  downlink-frequency: 923000000
+  min-data-rate: 0
+  max-data-rate: 5
+- uplink-frequency: 922000000
+  downlink-frequency: 922000000
+  min-data-rate: 0
+  max-data-rate: 5
+lora-standard-channel:
+  frequency: 922100000
+  data-rate: 6
+fsk-channel:
+  frequency: 921800000
+  data-rate: 7

end-device/EU_433.yml

@@ -0,0 +1,43 @@
+band-id: EU_433
+sub-bands:
+- min-frequency: 433050000
+  max-frequency: 434790000
+  duty-cycle: 0.1 # NOTE: ETSI EN300220 limit is 10%; LoRaWAN limit for end-devices is 1%
+  max-eirp: 12.15
+channels:
+- uplink-frequency: 433175000
+  downlink-frequency: 433175000
+  min-data-rate: 0
+  max-data-rate: 5
+- uplink-frequency: 433375000
+  downlink-frequency: 433375000
+  min-data-rate: 0
+  max-data-rate: 5
+- uplink-frequency: 433575000
+  downlink-frequency: 433575000
+  min-data-rate: 0
+  max-data-rate: 5
+- uplink-frequency: 433775000
+  downlink-frequency: 433775000
+  min-data-rate: 0
+  max-data-rate: 5
+- uplink-frequency: 433975000
+  downlink-frequency: 433975000
+  min-data-rate: 0
+  max-data-rate: 5
+- uplink-frequency: 434175000
+  downlink-frequency: 434175000
+  min-data-rate: 0
+  max-data-rate: 5
+- uplink-frequency: 434375000
+  downlink-frequency: 434375000
+  min-data-rate: 0
+  max-data-rate: 5
+- uplink-frequency: 434575000
+  downlink-frequency: 434575000
+  min-data-rate: 0
+  max-data-rate: 5
+lora-standard-channel:
+  frequency: 434075000
+  data-rate: 6
+

end-device/EU_863_870_ROAMING_DRAFT.yml

@@ -0,0 +1,31 @@
+
+band-id: EU_863_870
+sub-bands:
+  - min-frequency: 867100000
+    max-frequency: 868500000
+channels:
+- uplink-frequency: 868100000
+  downlink-frequency: 868100000
+  min-data-rate: 0
+  max-data-rate: 5
+- uplink-frequency: 868300000
+  downlink-frequency: 868300000
+  min-data-rate: 0
+  max-data-rate: 5
+- uplink-frequency: 868500000
+  downlink-frequency: 868500000
+  min-data-rate: 0
+  max-data-rate: 5
+- uplink-frequency: 867100000
+  downlink-frequency: 867100000
+  min-data-rate: 0
+  max-data-rate: 5
+- uplink-frequency: 867300000
+  downlink-frequency: 867300000
+  min-data-rate: 0
+  max-data-rate: 5
+- uplink-frequency: 867900000
+  downlink-frequency: 867900000
+  min-data-rate: 0
+  max-data-rate: 5
+

end-device/US_902_928_FSB_1.yml

@@ -0,0 +1,36 @@
+band-id: US_902_928
+sub-bands:
+  - min-frequency: 902300000
+    max-frequency: 903700000
+channels:
+- uplink-frequency: 902300000
+  min-data-rate: 0
+  max-data-rate: 3
+- uplink-frequency: 902500000
+  min-data-rate: 0
+  max-data-rate: 3
+- uplink-frequency: 902700000
+  min-data-rate: 0
+  max-data-rate: 3
+- uplink-frequency: 902900000
+  min-data-rate: 0
+  max-data-rate: 3
+- uplink-frequency: 903100000
+  min-data-rate: 0
+  max-data-rate: 3
+- uplink-frequency: 903300000
+  min-data-rate: 0
+  max-data-rate: 3
+- uplink-frequency: 903500000
+  min-data-rate: 0
+  max-data-rate: 3
+- uplink-frequency: 903700000
+  min-data-rate: 0
+  max-data-rate: 3
+lora-standard-channel:
+  frequency: 903000000
+  data-rate: 12
+dwell-time:
+  uplinks: true
+  downlinks: false
+  duration: 400ms

end-device/modifiers/disable_dwell_time.yml

@@ -0,0 +1,4 @@
+dwell-time:
+  uplinks: false
+  downlinks: false
+  duration: 0ms

end-device/modifiers/enable_dwell_time_400ms.yml

@@ -0,0 +1,4 @@
+dwell-time:
+  uplinks: true
+  downlinks: true
+  duration: 400ms

end-device/modifiers/lbt_80_over_128.yml

@@ -0,0 +1,4 @@
+listen-before-talk:
+  rssi-offset: -4
+  rssi-target: -80
+  scan-time: 128000

end-device/schema.json

@@ -48,7 +48,7 @@
           },
           "downlink-frequency": {
             "type": "integer",
-            "description": "Downlink frequency [Hz] (optional)"
+            "description": "Downlink frequency [Hz]"
           },
           "min-data-rate": {
             "type": "integer",

frequency-plans.yml

@@ -18,6 +18,52 @@ end-device-descriptions:
   modifiers: [rx2_default_data_rata_3.yml]
   endorsed: true
 
+- id: EU_863_870_ROAMING_DRAFT
+  band-id: EU_863_870
+  name: Europe 863-870 MHz, 6 channels for roaming (Draft)
+  description: European 6 channel plan used by major operators to support LoRaWAN Passive Roaming
+  base-frequency: 868
+  country-codes: [al, ad, ao, at, bh, be, ba, bw, bg, cg, hr, cy, cz, dk, ee, sz, fi, fr, gr, hu, is, ie, it, lv, ls, li, lt, lu, mg, mw, mt, mu, md, me, mz, na, nl, mk, ph, pl, pt, ro, ru, sa, rs, sc, sk, si, za, es, se, ch, tz, tr, ae, gb, va, zm, zw]
+  file: EU_863_870_ROAMING_DRAFT.yml
+  endorsed: false
+
+- id: EU_433
+  band-id: EU_433
+  name: Europe 433 MHz (ITU region 1)
+  description: Default frequency plan for worldwide 433MHz
+  base-frequency: 433
+  country-codes: [worldwide]
+  file: EU_433.yml
+  endorsed: true
+
+- id: US_902_928_FSB_1
+  band-id: US_902_928
+  name: United States 902-928 MHz, FSB 1
+  description: Default frequency plan for the United States and Canada, using sub-band 1
+  base-frequency: 915
+  country-codes: [ca, cr, ec, gy, mx, pa, pr, us]
+  file: US_902_928_FSB_1.yml
+  endorsed: true
+
+- id: AS_920_923
+  band-id: AS_923
+  name: Asia 920-923 MHz
+  description: TTN Community Network frequency plan for Asian countries, using frequencies ≤ 923 MHz
+  base-frequency: 915
+  country-codes: [my, sg]
+  file: AS_920_923.yml
+  endorsed: true
+
+- id: AS_920_923_LBT
+  band-id: AS_923
+  base-id: AS_920_923
+  name: Asia 920-923 MHz with LBT
+  description: TTN Community Network frequency plan for Asian countries, using frequencies ≤ 923 MHz with listen-before-talk
+  base-frequency: 915
+  country-codes: [jp, my, sg]
+  modifiers: [lbt_80_over_128.yml]
+  endorsed: false
+
 gateway-descriptions:
 - id: EU_863_870
   band-id: EU_863_870
@@ -27,3 +73,31 @@ gateway-descriptions:
   country-codes: [al, ad, ao, at, bh, be, ba, bw, bg, cg, hr, cy, cz, dk, ee, sz, fi, fr, gr, hu, is, ie, it, lv, ls, li, lt, lu, mg, mw, mt, mu, md, me, mz, na, nl, mk, ph, pl, pt, ro, ru, sa, rs, sc, sk, si, za, es, se, ch, tz, tr, ae, gb, va, zm, zw]
   file: EU_863_870.yml
   endorsed: false
+
+- id: EU_433
+  band-id: EU_433
+  name: Europe 433 MHz (ITU region 1)
+  description: Default frequency plan for worldwide 433MHz
+  base-frequency: 433
+  country-codes: [worldwide]
+  file: EU_433.yml
+  endorsed: true
+
+- id: AS_920_923
+  band-id: AS_923
+  name: Asia 920-923 MHz
+  description: TTN Community Network frequency plan for Asian countries, using frequencies ≤ 923 MHz
+  base-frequency: 915
+  country-codes: [my, sg]
+  file: AS_920_923.yml
+  endorsed: true
+
+- id: AS_920_923_LBT
+  band-id: AS_923
+  base-id: AS_920_923
+  name: Asia 920-923 MHz with LBT
+  description: TTN Community Network frequency plan for Asian countries, using frequencies ≤ 923 MHz with listen-before-talk
+  base-frequency: 915
+  country-codes: [jp, my, sg]
+  modifiers: [lbt_80_over_128.yml]
+  endorsed: false