Manual:Interface/Lora: Difference between revisions

From MikroTik Wiki
Jump to navigation Jump to search
No edit summary
 
(6 intermediate revisions by one other user not shown)
Line 3: Line 3:
<b>Package:</b> <code>system</code>,<code>lora</code>
<b>Package:</b> <code>system</code>,<code>lora</code>
</p>
</p>
<p>Every RouterBOARD with a miniPCI-e interface (with connected USB lines) could be turn in LoRaWAN gateway by installation of <b>R11e-LoRa8</b> or <b>R11e-LoRa9</b> card. </p>
<p>Any RouterBOARD with a miniPCI-e interface which supports LTE modems can also be turned into a LoRaWAN gateway by installation of a <b>R11e-LoRa8</b> or <b>R11e-LoRa9</b> card. </p>
{{Warning | RouterOS doesn`t support 3rd party LoRaWAN gateway cards}}
{{Warning | RouterOS doesn`t support 3rd party LoRaWAN gateway cards}}


Line 90: Line 90:
}}
}}


{{Mr-arg-table
{{Mr-arg-table-end
|arg=src-address
|arg=src-address
|type=IP
|type=IP
Line 99: Line 99:


==Channels==
==Channels==
<p id="shbox">
<b>Sub-menu:</b> <code>/lora channels</code>
</p>
{{Mr-arg-table-h
|prop=Property
|desc=Description
}}
{{Mr-arg-table
|arg=bandwidth
|type=7.8_kHz {{!}} 15.6_kHz {{!}} 31.2_kHz {{!}} 62.5_kHz {{!}} 125_kHz {{!}} 250_kHz {{!}} 500_kHz
|default=125_kHz
|desc=Bandwidth of specific channel, pre-defined when any of channel-plan preset is used, but could be manually changed when channel-plan is set to custom.
}}
{{Mr-arg-table
|arg=disabled
|type= yes {{!}} no
|default=no
|desc=Whether specific channel is disabled.
}}
{{Mr-arg-table
|arg=freq-off
|type=integer [Hz]
|default=
|desc=Channel frequency offset against radio central frequency, it makes possible to adjust channel frequencies so that channels doesn`t overlap.
}}
{{Mr-arg-table
|arg=radio
|type= radio0 {{!}} radio1
|default=
|desc=Defines which radio uses selected channel.
}}
{{Mr-arg-table-end
|arg=spread-factor
|type=SF7 {{!}} SF8 {{!}} SF9 {{!}} SF10 {{!}} SF11 {{!}} SF12
|default=
|desc=Defines the Spread Factor for a channel with type=LoRa. Lower Spread Factor means higher data rate.
}}
==Radios==
<p id="shbox">
<b>Sub-menu:</b> <code>/lora radios</code>
</p>
{{Mr-arg-table-h
|prop=Property
|desc=Description
}}
{{Mr-arg-table
|arg=center-freq
|type=integer [0..4294967295Hz]
|default=
|desc=Defines radio central frequency, default value depends on selected channel-plan.
}}
{{Mr-arg-table
|arg=disabled
|type= yes {{!}} no
|default=no
|desc=Whether radio is disabled.
}}
{{Mr-arg-table
|arg=rssi-off
|type=integer
|default=-162
|desc=Used to calculate precise RSSI level of received packets
}}
{{Mr-arg-table
|arg=tx-enabled
|type= yes {{!}} no
|default=
|desc=Whether radio is used for transmission. By default one of radios has set tx-enabled=yes and the other has set tx-enabled=no.
}}
{{Mr-arg-table
|arg=tx-freq-min
|type=integer [0..4294967295Hz]
|default=
|desc=
}}
{{Mr-arg-table-end
|arg=tx-freq-max
|type=integer [0..4294967295Hz]
|default=
|desc=
}}
==Servers==
<p id="shbox">
<b>Sub-menu:</b> <code>/lora servers</code>
</p>
<p>There are two pre-defined servers that could be used (it requires to make an [http://thethingsnetwork.org | The Things Network] account to use them):</p>
<pre>
[admin@MikroTik] > lora servers print
# NAME            UP-PORT DOWN-PORT ADDRESS                                                                                                                                         
0 TTN-EU              1700      1700 eu.mikrotik.thethings.industries                                                                                                               
1 TTN-US              1700      1700 us.mikrotik.thethings.industries                                                                                                               
</pre>
<p>Of course, custom servers can be added too.</p>
{{Mr-arg-table-h
|prop=Property
|desc=Description
}}
{{Mr-arg-table
|arg=address
|type=domain name or IP address
|default=
|desc=Defines LoRaWAN Network server address.
}}
{{Mr-arg-table
|arg=down-port
|type=integer [0..65535]
|default=
|desc=Defines port for down-link communication (from server to node) with LoRaWAN Network server. Most of known open source servers uses port 1700 as default, but it can change if multiple servers are configured on the same machine.
}}
{{Mr-arg-table
|arg=name
|type=string
|default=
|desc=Defines server name.
}}
{{Mr-arg-table-end
|arg=up-port
|type=integer [0..65535]
|default=
|desc=Defines port for up-link communication (from node to server) with LoRaWAN Network server. Most of known open source servers uses port 1700 as default, but it can change if multiple servers are configured on the same machine.
}}

Latest revision as of 11:36, 8 January 2021

Summary

Package: system,lora

Any RouterBOARD with a miniPCI-e interface which supports LTE modems can also be turned into a LoRaWAN gateway by installation of a R11e-LoRa8 or R11e-LoRa9 card.

Warning: RouterOS doesn`t support 3rd party LoRaWAN gateway cards


Properties

Sub-menu: /lora

Property Description
antenna-gain (integer [-128..127]; Default: 0) Antenna gain in dBi.
channel-plan (as-923 | au-915 | custom | eu-868 | in-865 | kr-920 | ru-864 | us-915; Default: eu-868) Frequency plans for various regions.
disabled (yes | no; Default: yes) Whether LoRaWAN gateway is disabled.
forward (crc-disabled | crc-error | crc-valid; Default: crc-valid,crc-error) Defines what kind of packets should be forwarded to Network server:
  • crc-disabled - forward packets which CRC code isn`t checked
  • crc-error - forward packets with incorrect CRC code
  • crc-valid - forward valid packets with correct CRC.
lbt-enabled (yes | no; Default: no) Whether gateway should use LBT (Listen Before Talk) protocol.
listen-time (integer [0us..4294967295us]; Default: 5000us) Time in microseconds to track RSSI before TX (used when lbt-enabled=yes).
name (string; Default: ) Name of LoRaWAN gateway.
network (private | public; Default: public) Whether sync word should be used (network=private) or shouldn`t (network=public).
rssi-threshold (integer [-32,768 .. 32,767]; Default: -65dB) RSSI value to determine whether forwarder may use specific channel to talk. If RSSI value is below rssi-threshold, channel could be used (used when lbt-enabled=yes).
servers (list of string; Default: ) Name or names of servers from /lora servers.
src-address (IP; Default: ) Specifies uplink packet source address if necessary (address should match an address configured on the RB).


Channels

Sub-menu: /lora channels

Property Description
bandwidth (7.8_kHz | 15.6_kHz | 31.2_kHz | 62.5_kHz | 125_kHz | 250_kHz | 500_kHz; Default: 125_kHz) Bandwidth of specific channel, pre-defined when any of channel-plan preset is used, but could be manually changed when channel-plan is set to custom.
disabled (yes | no; Default: no) Whether specific channel is disabled.
freq-off (integer [Hz]; Default: ) Channel frequency offset against radio central frequency, it makes possible to adjust channel frequencies so that channels doesn`t overlap.
radio (radio0 | radio1; Default: ) Defines which radio uses selected channel.
spread-factor (SF7 | SF8 | SF9 | SF10 | SF11 | SF12; Default: ) Defines the Spread Factor for a channel with type=LoRa. Lower Spread Factor means higher data rate.


Radios

Sub-menu: /lora radios

Property Description
center-freq (integer [0..4294967295Hz]; Default: ) Defines radio central frequency, default value depends on selected channel-plan.
disabled (yes | no; Default: no) Whether radio is disabled.
rssi-off (integer; Default: -162) Used to calculate precise RSSI level of received packets
tx-enabled (yes | no; Default: ) Whether radio is used for transmission. By default one of radios has set tx-enabled=yes and the other has set tx-enabled=no.
tx-freq-min (integer [0..4294967295Hz]; Default: )
tx-freq-max (integer [0..4294967295Hz]; Default: )


Servers

Sub-menu: /lora servers

There are two pre-defined servers that could be used (it requires to make an | The Things Network account to use them):

[admin@MikroTik] > lora servers print
 # NAME             UP-PORT DOWN-PORT ADDRESS                                                                                                                                          
 0 TTN-EU              1700      1700 eu.mikrotik.thethings.industries                                                                                                                 
 1 TTN-US              1700      1700 us.mikrotik.thethings.industries                                                                                                                 

Of course, custom servers can be added too.

Property Description
address (domain name or IP address; Default: ) Defines LoRaWAN Network server address.
down-port (integer [0..65535]; Default: ) Defines port for down-link communication (from server to node) with LoRaWAN Network server. Most of known open source servers uses port 1700 as default, but it can change if multiple servers are configured on the same machine.
name (string; Default: ) Defines server name.
up-port (integer [0..65535]; Default: ) Defines port for up-link communication (from node to server) with LoRaWAN Network server. Most of known open source servers uses port 1700 as default, but it can change if multiple servers are configured on the same machine.