This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
wiki:keros_custo:keros_applications_configuration [2021/10/04 17:22] ehe [Examples] |
wiki:keros_custo:keros_applications_configuration [2023/06/02 10:25] (current) ehe |
||
---|---|---|---|
Line 5: | Line 5: | ||
===== klk_apps_config ===== | ===== klk_apps_config ===== | ||
- | klk_apps_config is a small script used to configure Kerlink Common Packet Forwarder and WMC Embedded applications. \\ | + | klk_apps_config is a script used to configure Kerlink Common Packet Forwarder and WMC Embedded applications. \\ |
Kerlink advises to reboot the gateway after using klk_apps_config to enable/disable an application. | Kerlink advises to reboot the gateway after using klk_apps_config to enable/disable an application. | ||
<code> | <code> | ||
- | # klk_apps_config -h | + | root@klk-lpbs-04038E:~ # klk_apps_config -h |
klk_apps_config [options] | klk_apps_config [options] | ||
options: | options: | ||
- | -h, --help show help | + | -h, --help show help |
- | --activate-wmc activate wmc embedded (and CPF) | + | --activate-wmc activate wmc embedded (and CPF) |
- | --deactivate-wmc deactivate wmc embedded (and CPF) | + | --deactivate-wmc deactivate wmc embedded (and CPF) |
- | --activate-cpf activate lorad and lorafwd | + | --activate-cpf activate lorad and lorafwd |
- | --deactivate-cpf deactivate lorad and lorafwd | + | --deactivate-cpf deactivate lorad and lorafwd |
- | -s, --wmc-server WMC server (mandatory if activating WMC) | + | --activate-lorad activate lorad |
- | -p, --wmc-port WMC port (default 1194) | + | --deactivate-lorad deactivate lorad |
- | --lns-server LNS server (default 172.17.0.1) | + | --activate-lorafwd activate lorafwd |
- | --lns-dport LNS downlink port (default 1700) | + | --deactivate-lorafwd deactivate lorafwd |
- | --lns-uport LNS uplink port (default 1700) | + | -i, --lorafwd-instance lorafwd instance name (system lorafwd by default) |
- | --loradconf lorad configuration file name/path | + | -s, --wmc-server WMC server (mandatory if activating WMC) |
+ | -p, --wmc-port WMC port (default 1194) | ||
+ | --lns-server LNS server (default 172.17.0.1) | ||
+ | --lns-dport LNS downlink port (default 1700) | ||
+ | --lns-uport LNS uplink port (default 1700) | ||
+ | --loradconf lorad configuration file name/path | ||
Can be: | Can be: | ||
- a complete file path | - a complete file path | ||
Line 30: | Line 35: | ||
This script can be used to: | This script can be used to: | ||
- | * activate CPF (lorad and lorafwd) only. | + | * activate CPF (lorad and lorafwd) |
* deactivate CPF | * deactivate CPF | ||
+ | * activate lorad | ||
+ | * deactivate lorad | ||
+ | * activate lorafwd | ||
+ | * deactivate lorafwd | ||
* activate WMC embedded applications (CPF + BSCC + lora_snmp) | * activate WMC embedded applications (CPF + BSCC + lora_snmp) | ||
* deactivate WMC embedded applications | * deactivate WMC embedded applications | ||
Line 39: | Line 48: | ||
Script parameters details: | Script parameters details: | ||
- | * One of the four possible actions must be chosen (activate-wmc, deactivate-wmc, activate-cpf, deactivate-cpf) | + | * One of the eight possible actions must be chosen (ex: activate-cpf) |
* ''-////-wmc-server'': address of the WMC server to connect to (example: wmcvalidinstall.wanesy.com) | * ''-////-wmc-server'': address of the WMC server to connect to (example: wmcvalidinstall.wanesy.com) | ||
* ''-////-wmc-port'': port of the WMC server to connect to | * ''-////-wmc-port'': port of the WMC server to connect to | ||
+ | * ''-////-lorafwd-instance'': lorafwd instance name (system lorafwd by default) | ||
* ''-////-lns-server'': address of the LNS server (lorafwd parameter) | * ''-////-lns-server'': address of the LNS server (lorafwd parameter) | ||
* ''-////-lns-dport'': LNS downlink port (lorafwd parameter) | * ''-////-lns-dport'': LNS downlink port (lorafwd parameter) | ||
* ''-////-lns-uport'': LNS uplink port (lorafwd parameter) | * ''-////-lns-uport'': LNS uplink port (lorafwd parameter) | ||
* ''-////-loradconf'': this can be the complete path of the Lorad configuration you want to use or the file name of the example lorad configuration delivered for your platform. If not given the platform default will be used (EU868XXX.json) | * ''-////-loradconf'': this can be the complete path of the Lorad configuration you want to use or the file name of the example lorad configuration delivered for your platform. If not given the platform default will be used (EU868XXX.json) | ||
+ | |||
<note important>Please note that to use WMC Embedded application, you still have to install the required security certificate; | <note important>Please note that to use WMC Embedded application, you still have to install the required security certificate; | ||
- | [[https://wikikerlink.fr/wanesy-ran/doku.php?id=wiki:wiki3:gateway_sw_4.3.3|WMC installation page]] | + | [[https://wikikerlink.fr/wanesy-ran/doku.php?id=wiki:wiki3:quickstart|WMC quickstart]] |
</note> | </note> | ||
- | ===== Examples ===== | + | ===== Connect a Wirnet i-series gateway to The Things Network ===== |
- | Activate the CPF on european TTN server: | + | Activation of the CPF on European TTN server: |
<code> | <code> | ||
klk_apps_config --activate-cpf --lns-server eu1.cloud.thethings.network --lns-dport 1700 --lns-uport 1700 | klk_apps_config --activate-cpf --lns-server eu1.cloud.thethings.network --lns-dport 1700 --lns-uport 1700 | ||
Line 63: | Line 74: | ||
</code> | </code> | ||
- | For example about how to activate the WMC on your gateway, consult the WMC wiki page: [[https://wikikerlink.fr/wanesy-ran/doku.php?id=wiki:wiki3:gateway_sw_4.3.3|click here]]. | + | If you need to activate the WMC on your gateway, consult the WMC wiki page: [[https://wikikerlink.fr/wanesy-ran/doku.php?id=wiki:wiki3:gateway_sw_4.3.3|click here]]. |
+ | |||
+ | Kerlink also recommends to consult the TTN page: [[https://www.thethingsindustries.com/docs/getting-started/ttn/addresses/|click here]]. | ||
+ | ===== Connect a Wirnet i-series gateway to ChirpStack ===== | ||
+ | |||
+ | See on [[https://www.chirpstack.io/docs/chirpstack-mqtt-forwarder/install/kerlink.html|ChirpStack]] | ||
+ | |||
+ | ===== Connect more than one Packet Forwarder ===== | ||
+ | Multiple instance of lorafwd can be used using [[wiki:lora:multiforwarder|lorafwd_instance_manager]] | ||
+ | |||
+ | To configure one you will need to specify the name of the instance using the -i flag in addition of the other parameter for the address and ports: | ||
+ | <code>klk_apps_config --activate-lorafwd -i second_instance --lns-server second_instance.url --lns-dport 1700 --lns-uport 1700</code> | ||
- | You can consult the TTN page: [[https://www.thethingsindustries.com/docs/getting-started/ttn/addresses/|click here]]. | ||