This repository has been archived by the owner on Dec 14, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 279
/
band.go
234 lines (219 loc) · 11 KB
/
band.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
// Copyright © 2017 The Things Network
// Use of this source code is governed by the MIT license that can be found in the LICENSE file.
package band
import (
"sync"
pb_lorawan "github.com/TheThingsNetwork/api/protocol/lorawan"
"github.com/TheThingsNetwork/ttn/core/types"
"github.com/TheThingsNetwork/ttn/utils/errors"
"github.com/brocaar/lorawan"
lora "github.com/brocaar/lorawan/band"
"github.com/spf13/viper"
)
// FrequencyPlan includes band configuration and CFList
type FrequencyPlan struct {
lora.Band
ADR *ADRConfig
CFList *lorawan.CFList
}
func (f *FrequencyPlan) GetDataRateStringForIndex(drIdx int) (string, error) {
dr, err := types.ConvertDataRate(f.DataRates[drIdx])
if err != nil {
return "", err
}
return dr.String(), nil
}
func (f *FrequencyPlan) GetDataRateIndexFor(dataRate string) (int, error) {
dr, err := types.ParseDataRate(dataRate)
if err != nil {
return 0, err
}
return f.Band.GetDataRate(lora.DataRate{Modulation: lora.LoRaModulation, SpreadFactor: int(dr.SpreadingFactor), Bandwidth: int(dr.Bandwidth)})
}
func (f *FrequencyPlan) GetTxPowerIndexFor(txPower int) (int, error) {
for i, power := range f.TXPower {
if power == txPower {
return i, nil
}
}
return 0, errors.New("core/band: the given tx-power does not exist")
}
// Guess the region based on frequency
func Guess(frequency uint64) string {
// Join frequencies
switch {
case frequency == 923200000 || frequency == 923400000:
// not considering AS_920_923 and AS_923_925 because we're not sure
return pb_lorawan.FrequencyPlan_AS_923.String()
case frequency == 922100000 || frequency == 922300000 || frequency == 922500000:
return pb_lorawan.FrequencyPlan_KR_920_923.String()
}
// Existing Channels
if region, ok := channels[int(frequency)]; ok {
return region
}
// Everything Else: not allowed
return ""
}
func init() {
viper.SetDefault("eu-rx2-dr", "3")
viper.SetDefault("us-fsb", "1")
viper.SetDefault("au-fsb", "1")
}
// Get the frequency plan for the given region
func Get(region string) (frequencyPlan FrequencyPlan, err error) {
if fp, ok := frequencyPlans[region]; ok {
return fp, nil
}
switch region {
case pb_lorawan.FrequencyPlan_EU_863_870.String():
frequencyPlan.Band, err = lora.GetConfig(lora.EU_863_870, false, lorawan.DwellTimeNoLimit)
// TTN frequency plan includes extra channels next to the default channels:
frequencyPlan.UplinkChannels = []lora.Channel{
lora.Channel{Frequency: 868100000, DataRates: []int{0, 1, 2, 3, 4, 5}},
lora.Channel{Frequency: 868300000, DataRates: []int{0, 1, 2, 3, 4, 5, 6}}, // Also SF7BW250
lora.Channel{Frequency: 868500000, DataRates: []int{0, 1, 2, 3, 4, 5}},
lora.Channel{Frequency: 867100000, DataRates: []int{0, 1, 2, 3, 4, 5}},
lora.Channel{Frequency: 867300000, DataRates: []int{0, 1, 2, 3, 4, 5}},
lora.Channel{Frequency: 867500000, DataRates: []int{0, 1, 2, 3, 4, 5}},
lora.Channel{Frequency: 867700000, DataRates: []int{0, 1, 2, 3, 4, 5}},
lora.Channel{Frequency: 867900000, DataRates: []int{0, 1, 2, 3, 4, 5}},
lora.Channel{Frequency: 868800000, DataRates: []int{7}}, // FSK 50kbps
}
frequencyPlan.DownlinkChannels = frequencyPlan.UplinkChannels
frequencyPlan.CFList = &lorawan.CFList{867100000, 867300000, 867500000, 867700000, 867900000}
frequencyPlan.ADR = &ADRConfig{MinDataRate: 0, MaxDataRate: 5, MinTXPower: 2, MaxTXPower: 14, StepTXPower: 3}
frequencyPlan.RX2DataRate = viper.GetInt("eu-rx2-dr")
case pb_lorawan.FrequencyPlan_US_902_928.String():
frequencyPlan.Band, err = lora.GetConfig(lora.US_902_928, false, lorawan.DwellTime400ms)
fsb := viper.GetInt("us-fsb") // If this is 1, enables 903.9-905.3/200 kHz, 904.6/500kHz channels, etc.
for channel := 0; channel < 72; channel++ {
if (channel < fsb*8 || channel >= (fsb+1)*8) && channel != fsb+64 {
frequencyPlan.DisableUplinkChannel(channel)
}
}
frequencyPlan.ADR = &ADRConfig{MinDataRate: 0, MaxDataRate: 3, MinTXPower: 10, MaxTXPower: 20, StepTXPower: 2}
case pb_lorawan.FrequencyPlan_CN_779_787.String():
frequencyPlan.Band, err = lora.GetConfig(lora.CN_779_787, false, lorawan.DwellTimeNoLimit)
case pb_lorawan.FrequencyPlan_EU_433.String():
frequencyPlan.Band, err = lora.GetConfig(lora.EU_433, false, lorawan.DwellTimeNoLimit)
case pb_lorawan.FrequencyPlan_AU_915_928.String():
frequencyPlan.Band, err = lora.GetConfig(lora.AU_915_928, false, lorawan.DwellTime400ms)
fsb := viper.GetInt("au-fsb") // If this is 1, enables 916.8-918.2/200 kHz, 917.5/500kHz channels, etc.
for channel := 0; channel < 72; channel++ {
if (channel < fsb*8 || channel >= (fsb+1)*8) && channel != fsb+64 {
frequencyPlan.DisableUplinkChannel(channel)
}
}
frequencyPlan.ADR = &ADRConfig{MinDataRate: 0, MaxDataRate: 5, MinTXPower: 10, MaxTXPower: 20, StepTXPower: 2}
case pb_lorawan.FrequencyPlan_CN_470_510.String():
frequencyPlan.Band, err = lora.GetConfig(lora.CN_470_510, false, lorawan.DwellTimeNoLimit)
case pb_lorawan.FrequencyPlan_AS_923.String():
frequencyPlan.Band, err = lora.GetConfig(lora.AS_923, false, lorawan.DwellTime400ms)
frequencyPlan.ADR = &ADRConfig{MinDataRate: 0, MaxDataRate: 5, MinTXPower: 2, MaxTXPower: 14, StepTXPower: 2}
case pb_lorawan.FrequencyPlan_AS_920_923.String():
frequencyPlan.Band, err = lora.GetConfig(lora.AS_923, false, lorawan.DwellTime400ms)
frequencyPlan.UplinkChannels = []lora.Channel{
lora.Channel{Frequency: 923200000, DataRates: []int{0, 1, 2, 3, 4, 5}},
lora.Channel{Frequency: 923400000, DataRates: []int{0, 1, 2, 3, 4, 5}},
lora.Channel{Frequency: 922200000, DataRates: []int{0, 1, 2, 3, 4, 5}},
lora.Channel{Frequency: 922400000, DataRates: []int{0, 1, 2, 3, 4, 5}},
lora.Channel{Frequency: 922600000, DataRates: []int{0, 1, 2, 3, 4, 5}},
lora.Channel{Frequency: 922800000, DataRates: []int{0, 1, 2, 3, 4, 5}},
lora.Channel{Frequency: 923000000, DataRates: []int{0, 1, 2, 3, 4, 5}},
lora.Channel{Frequency: 922000000, DataRates: []int{0, 1, 2, 3, 4, 5}},
lora.Channel{Frequency: 922100000, DataRates: []int{6}},
lora.Channel{Frequency: 921800000, DataRates: []int{7}},
}
frequencyPlan.DownlinkChannels = frequencyPlan.UplinkChannels
frequencyPlan.CFList = &lorawan.CFList{922200000, 922400000, 922600000, 922800000, 923000000}
frequencyPlan.ADR = &ADRConfig{MinDataRate: 0, MaxDataRate: 5, MinTXPower: 2, MaxTXPower: 14, StepTXPower: 2}
case pb_lorawan.FrequencyPlan_AS_923_925.String():
frequencyPlan.Band, err = lora.GetConfig(lora.AS_923, false, lorawan.DwellTime400ms)
frequencyPlan.UplinkChannels = []lora.Channel{
lora.Channel{Frequency: 923200000, DataRates: []int{0, 1, 2, 3, 4, 5}},
lora.Channel{Frequency: 923400000, DataRates: []int{0, 1, 2, 3, 4, 5}},
lora.Channel{Frequency: 923600000, DataRates: []int{0, 1, 2, 3, 4, 5}},
lora.Channel{Frequency: 923800000, DataRates: []int{0, 1, 2, 3, 4, 5}},
lora.Channel{Frequency: 924000000, DataRates: []int{0, 1, 2, 3, 4, 5}},
lora.Channel{Frequency: 924200000, DataRates: []int{0, 1, 2, 3, 4, 5}},
lora.Channel{Frequency: 924400000, DataRates: []int{0, 1, 2, 3, 4, 5}},
lora.Channel{Frequency: 924600000, DataRates: []int{0, 1, 2, 3, 4, 5}},
lora.Channel{Frequency: 924500000, DataRates: []int{6}},
lora.Channel{Frequency: 924800000, DataRates: []int{7}},
}
frequencyPlan.DownlinkChannels = frequencyPlan.UplinkChannels
frequencyPlan.CFList = &lorawan.CFList{923600000, 923800000, 924000000, 924200000, 924400000}
frequencyPlan.ADR = &ADRConfig{MinDataRate: 0, MaxDataRate: 5, MinTXPower: 2, MaxTXPower: 14, StepTXPower: 2}
case pb_lorawan.FrequencyPlan_KR_920_923.String():
frequencyPlan.Band, err = lora.GetConfig(lora.KR_920_923, false, lorawan.DwellTimeNoLimit)
// TTN frequency plan includes extra channels next to the default channels:
frequencyPlan.UplinkChannels = []lora.Channel{
lora.Channel{Frequency: 922100000, DataRates: []int{0, 1, 2, 3, 4, 5}},
lora.Channel{Frequency: 922300000, DataRates: []int{0, 1, 2, 3, 4, 5}},
lora.Channel{Frequency: 922500000, DataRates: []int{0, 1, 2, 3, 4, 5}},
lora.Channel{Frequency: 922700000, DataRates: []int{0, 1, 2, 3, 4, 5}},
lora.Channel{Frequency: 922900000, DataRates: []int{0, 1, 2, 3, 4, 5}},
lora.Channel{Frequency: 923100000, DataRates: []int{0, 1, 2, 3, 4, 5}},
lora.Channel{Frequency: 923300000, DataRates: []int{0, 1, 2, 3, 4, 5}},
}
frequencyPlan.DownlinkChannels = frequencyPlan.UplinkChannels
frequencyPlan.CFList = &lorawan.CFList{922700000, 922900000, 923100000, 923300000, 0}
frequencyPlan.ADR = &ADRConfig{MinDataRate: 0, MaxDataRate: 5, MinTXPower: 2, MaxTXPower: 14, StepTXPower: 2}
case pb_lorawan.FrequencyPlan_IN_865_867.String():
frequencyPlan.Band, err = lora.GetConfig(lora.IN_865_867, false, lorawan.DwellTimeNoLimit)
case pb_lorawan.FrequencyPlan_RU_864_870.String():
frequencyPlan.Band, err = lora.GetConfig(lora.RU_864_870, false, lorawan.DwellTimeNoLimit)
// Here channels from recommended list for Russia are set which are used by LoRaWAN networks in Russia
// Recommended frequency plan includes extra channels next to the default channels:
frequencyPlan.UplinkChannels = []lora.Channel{
lora.Channel{Frequency: 868900000, DataRates: []int{0, 1, 2, 3, 4, 5}},
lora.Channel{Frequency: 869100000, DataRates: []int{0, 1, 2, 3, 4, 5}},
lora.Channel{Frequency: 864100000, DataRates: []int{0, 1, 2, 3, 4, 5}},
lora.Channel{Frequency: 864300000, DataRates: []int{0, 1, 2, 3, 4, 5}},
lora.Channel{Frequency: 864500000, DataRates: []int{0, 1, 2, 3, 4, 5}},
lora.Channel{Frequency: 864700000, DataRates: []int{0, 1, 2, 3, 4, 5}},
lora.Channel{Frequency: 864900000, DataRates: []int{0, 1, 2, 3, 4, 5}},
}
frequencyPlan.DownlinkChannels = frequencyPlan.UplinkChannels
frequencyPlan.CFList = &lorawan.CFList{864100000, 864300000, 864500000, 864700000, 864900000}
frequencyPlan.ADR = &ADRConfig{MinDataRate: 0, MaxDataRate: 5, MinTXPower: 2, MaxTXPower: 14, StepTXPower: 3}
default:
err = errors.NewErrInvalidArgument("Frequency Band", "unknown")
}
return
}
var frequencyPlans map[string]FrequencyPlan
var channels map[int]string
var initializeOnce sync.Once
// InitializeTables initializes the frequency plan and channel tables.
func InitializeTables() {
initializeOnce.Do(func() {
frequencyPlans = make(map[string]FrequencyPlan)
channels = make(map[int]string)
for _, r := range []pb_lorawan.FrequencyPlan{ // ordering is important here
pb_lorawan.FrequencyPlan_EU_863_870,
pb_lorawan.FrequencyPlan_IN_865_867,
pb_lorawan.FrequencyPlan_US_902_928,
pb_lorawan.FrequencyPlan_CN_779_787,
pb_lorawan.FrequencyPlan_EU_433,
pb_lorawan.FrequencyPlan_AS_923,
pb_lorawan.FrequencyPlan_AS_920_923,
pb_lorawan.FrequencyPlan_AS_923_925,
pb_lorawan.FrequencyPlan_KR_920_923,
pb_lorawan.FrequencyPlan_AU_915_928,
pb_lorawan.FrequencyPlan_CN_470_510,
pb_lorawan.FrequencyPlan_RU_864_870,
} {
region := r.String()
frequencyPlans[region], _ = Get(region)
for _, ch := range frequencyPlans[region].UplinkChannels {
if len(ch.DataRates) > 1 { // ignore FSK channels
if _, ok := channels[ch.Frequency]; !ok { // ordering indicates priority
channels[ch.Frequency] = region
}
}
}
}
})
}