Update readme

TheThingsNetwork · Jan 30, 2023 · ecd370a · ecd370a
1 parent 158d637
commit ecd370a
Showing 1 changed file with 22 additions and 15 deletions.
diff --git a/README.md b/README.md
@@ -102,21 +102,30 @@ max-eirp: 29.15                 # Maximum EIRP (optional; used when sub-bands do
 
 An index of frequency plans is in `frequency-plans.yml`. This can take two forms depending on if it is a root frequency plan definition, or if it is a plan definition that modifies an existing plan.
 
-Root definition
+Base plan definition
 ```yml
-- id: EU_863_870_TTN       # ID of the frequency plan
-  band-id: EU_863_870      # ID of the LoRaWAN band (needs to match band-id in the definition)
-  name: Region 863-870 MHz # Name of the frequency plan, ending with frequency ranges
-  description: Default frequency plan for Europe # Description of the frequency plan
-  base-frequency: 868      # Base frequency in MHz for hardware support (433, 470, 868, 915 or 2450)
-  country-codes: []        # List of 2-digit ISO country codes for countries where this plan can be used
-  device-file: end-device/EU_863_870.yml     # File of the freqeuency plan definition
-  gateway-file: gateway/EU_863_870.yml
-  phy-versions: []
-  endorsed: true
+end-device-descriptions:
+  - id: EU_863_870           # ID of the frequency plan
+    band-id: EU_863_870      # ID of the LoRaWAN band (needs to match band-id in the definition)
+    name: Region 863-870 MHz # Name of the frequency plan, ending with frequency ranges
+    description: Default frequency plan for Europe # Description of the frequency plan
+    base-frequency: 868      # Base frequency in MHz for hardware support (433, 470, 868, 915 or 2450)
+    country-codes: []        # List of 2-digit ISO country codes for countries where this plan can be used
+    file: EU_863_870.yml     # Filename of the plan residing in the `end-device` folder
+    endorsed: true
+
+gateway-descriptions:
+  - id: EU_863_870           # ID of the frequency plan
+    band-id: EU_863_870      # ID of the LoRaWAN band (needs to match band-id in the definition)
+    name: Region 863-870 MHz # Name of the frequency plan, ending with frequency ranges
+    description: Default frequency plan for Europe # Description of the frequency plan
+    base-frequency: 868      # Base frequency in MHz for hardware support (433, 470, 868, 915 or 2450)
+    country-codes: []        # List of 2-digit ISO country codes for countries where this plan can be used
+    file: EU_863_870.yml     # Filename of the plan residing in the `gateway` folder
+    endorsed: true
 ```
 
-Modifying definition
+Inherited definition
 ```yml
 - id: EU_863_870_TTN       # ID of the frequency plan
   band-id: EU_863_870      # ID of the LoRaWAN band (needs to match band-id in the definition)
@@ -125,9 +134,7 @@ Modifying definition
   description: Default frequency plan for Europe # Description of the frequency plan
   base-frequency: 868      # Base frequency in MHz for hardware support (433, 470, 868, 915 or 2450)
   country-codes: []        # List of 2-digit ISO country codes for countries where this plan can be used
-  device-modifiers: []
-  gateway-modifiers: []
-  phy-versions: []
+  modifiers: []            # Filename of the modifier residing in the respective `end-device/modifiers` or `gateway/modifiers` folder.
   endorsed: true
 ```