This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
wiki:wiki3:quickstart [2021/01/13 16:54] ghi [Declare your end-devices] |
wiki:wiki3:quickstart [2021/10/11 10:20] tda |
||
---|---|---|---|
Line 2: | Line 2: | ||
[[wiki:wiki3:quickstart#install_the_gateway_software|Quick link to software]] | [[wiki:wiki3:quickstart#install_the_gateway_software|Quick link to software]] | ||
- | \\ | + | |
===== Documentation ===== | ===== Documentation ===== | ||
* //User Manual (online)//: [[wiki:wiki3:documentation|click here]]\\ | * //User Manual (online)//: [[wiki:wiki3:documentation|click here]]\\ | ||
* //GMS API Web services documentation (online)//: [[wiki:wiki3:gmsapi_doc|click here]] | * //GMS API Web services documentation (online)//: [[wiki:wiki3:gmsapi_doc|click here]] | ||
- | \\ | + | |
+ | ===== Zero Touch provisioning (ZTP) feature ===== | ||
+ | |||
+ | The KerOS FW 4.3.3 integrates the Zero Touch provisioning (ZTP) feature.\\ | ||
+ | When you receive the gateway, you don’t need anymore to install software or to configure it, it is plug&play: you connect the gateway to the network with an Ethernet connection and the gateway will be automatically self-provisioned and configured for your needs. \\ | ||
+ | |||
+ | Supported configuration includes: | ||
+ | * Connection to Kerlink Wanesy Management Center (WMC). | ||
+ | * 4G backhaul configuration. | ||
+ | * Chirpstack or TTN configuration. | ||
+ | |||
+ | ZTP feature is available when the gateway boots for the first time with an available internet connection. | ||
+ | <note important>The gateways already deployed or upgraded with KerOS FW 4.3.3 are not concerned by ZTP feature, only the gateways natively produced with KerOS FW 4.3.3 (and later versions) are concerned.</note> | ||
+ | <note warning>The gateway must remain powered up and connected to Internet with Ethernet during the entire ZTP process.</note> | ||
+ | |||
+ | To enable ZTP on a gateway, it must be pre-declared on Kerlink ZTP Management server. | ||
+ | Please contact Kerlink for more information at [[support@kerlink.fr]]. | ||
+ | |||
===== Connecting the gateways to the WMC ===== | ===== Connecting the gateways to the WMC ===== | ||
- | \\ | + | |
The first thing to do is to **install the software** that allows the gateway to connect to the WMC. \\ \\ | The first thing to do is to **install the software** that allows the gateway to connect to the WMC. \\ \\ | ||
You need to know the current WMC software release and then select the appropriate software to install according to this WMC software release version. | You need to know the current WMC software release and then select the appropriate software to install according to this WMC software release version. | ||
- | \\ | + | |
- | \\ | + | |
==== Check the WMC version ==== | ==== Check the WMC version ==== | ||
Line 25: | Line 43: | ||
{{:wiki3:wmc_version_2.png?1000|}} \\ | {{:wiki3:wmc_version_2.png?1000|}} \\ | ||
The WMC version is the version of the **Dashboard** component. For instance, in the screenshot above, the WMC version is 3.2.6. | The WMC version is the version of the **Dashboard** component. For instance, in the screenshot above, the WMC version is 3.2.6. | ||
- | \\ | + | |
- | \\ | + | |
==== Install the Gateway Software ==== | ==== Install the Gateway Software ==== | ||
- | \\ | + | |
Before installing the software, read the release note about your software release version [[ https://wikikerlink.fr/wanesy-ran/doku.php?id=wiki:wiki3:whatsnew_3x | here ]] | Before installing the software, read the release note about your software release version [[ https://wikikerlink.fr/wanesy-ran/doku.php?id=wiki:wiki3:whatsnew_3x | here ]] | ||
The connection to the **Wanesy Management Center** (WMC) requires several software packages to be installed on the gateway: | The connection to the **Wanesy Management Center** (WMC) requires several software packages to be installed on the gateway: | ||
- | \\ | + | |
* **Packet Forwarder packages**: process LoRa packets to forward to the WMC. | * **Packet Forwarder packages**: process LoRa packets to forward to the WMC. | ||
* **BSCC and SNMP packages**: handle software upgrades, gateway monitoring, etc. | * **BSCC and SNMP packages**: handle software upgrades, gateway monitoring, etc. | ||
* **OpenVPN packages**: create a secure channel between the gateway and the WMC. | * **OpenVPN packages**: create a secure channel between the gateway and the WMC. | ||
* An up-to-date **firmware**: a linux-based firmware to manage low-level functions (File management, security, network access, etc...) | * An up-to-date **firmware**: a linux-based firmware to manage low-level functions (File management, security, network access, etc...) | ||
- | \\ | + | |
For previous versions, these packages are brought together into a single package called a **"megapackage**". This specific software is also called the "**embedded software**". The version of the megapackage to install depends on the WMC software release. | For previous versions, these packages are brought together into a single package called a **"megapackage**". This specific software is also called the "**embedded software**". The version of the megapackage to install depends on the WMC software release. | ||
Line 52: | Line 70: | ||
| **WMC 3.0** | [[http://wikikerlink.fr/wanesy-ran/doku.php?id=wiki:wiki3:gateway_sw_3.0|Embedded Software Release v3.0.11]] | [[http://wikikerlink.fr/wanesy-ran/doku.php?id=wiki:wiki3:gateway_sw_3.0|Wirnet Station embedded sofware 3.0.10]] | | | **WMC 3.0** | [[http://wikikerlink.fr/wanesy-ran/doku.php?id=wiki:wiki3:gateway_sw_3.0|Embedded Software Release v3.0.11]] | [[http://wikikerlink.fr/wanesy-ran/doku.php?id=wiki:wiki3:gateway_sw_3.0|Wirnet Station embedded sofware 3.0.10]] | | ||
- | \\ | + | |
- | \\ | + | |
The upgrade procedure is described here: | The upgrade procedure is described here: | ||
Line 61: | Line 78: | ||
| **WMC 3.0** | [[https://wikikerlink.fr/wanesy-ran/doku.php?id=wiki:wiki3:faq_gw_first_install_3.0|Gateway Software Install WMC 3.0]] | | | **WMC 3.0** | [[https://wikikerlink.fr/wanesy-ran/doku.php?id=wiki:wiki3:faq_gw_first_install_3.0|Gateway Software Install WMC 3.0]] | | ||
- | \\ | ||
===== Configuring the WMC ===== | ===== Configuring the WMC ===== | ||
Once gateway embedded software has been installed, you have to configure the WMC: create your customers, create your fleets, declare your gateways, create your clusters and declare your end-devices. | Once gateway embedded software has been installed, you have to configure the WMC: create your customers, create your fleets, declare your gateways, create your clusters and declare your end-devices. | ||
- | \\ | + | |
- | \\ | + | |
==== Create your customers ==== | ==== Create your customers ==== | ||
Line 86: | Line 102: | ||
(if needed, replace the URL domain //wmc-poc.wanesy.com// by your own) \\ | (if needed, replace the URL domain //wmc-poc.wanesy.com// by your own) \\ | ||
{{:wiki3:create-fleet.b46d770c.gif?1000|}} | {{:wiki3:create-fleet.b46d770c.gif?1000|}} | ||
- | \\ | + | |
- | \\ | + | |
==== Declare your gateways ==== | ==== Declare your gateways ==== | ||
Line 125: | Line 140: | ||
- | \\ | ||
- | \\ | ||
==== Create your clusters ==== | ==== Create your clusters ==== | ||
Line 141: | Line 154: | ||
* Specify your push configuration for your cluster | * Specify your push configuration for your cluster | ||
- | \\ | + | |
=== Define your push configuration === | === Define your push configuration === | ||
- | \\ | + | |
Select the "push configurations" after selecting ''CLusters'' from the ''Administration'' menu: | Select the "push configurations" after selecting ''CLusters'' from the ''Administration'' menu: | ||
Line 149: | Line 162: | ||
(if needed, replace the URL domain //wmc-poc.wanesy.com// by your own) \\ | (if needed, replace the URL domain //wmc-poc.wanesy.com// by your own) \\ | ||
{{:wiki3:create-push-configuration.3f6476d0.gif?1000|}} | {{:wiki3:create-push-configuration.3f6476d0.gif?1000|}} | ||
- | \\ | + | |
== Define Identity parameters for your push configuration == | == Define Identity parameters for your push configuration == | ||
- | \\ | + | |
To create a **push configuration**, you need to define the following information: | To create a **push configuration**, you need to define the following information: | ||
Line 160: | Line 174: | ||
* **Type**: type of protocol to use: HTTP, Websocket or MQTT | * **Type**: type of protocol to use: HTTP, Websocket or MQTT | ||
* **Message detail level**: this field sets the granularity of the returned information. | * **Message detail level**: this field sets the granularity of the returned information. | ||
+ | |||
+ | About MQTT configuration, please read the following: | ||
+ | [[wiki:wiki3:faq_mqtt|FAQ: MQTT]] | ||
| | ||
For message detail level, 3 levels are available (from the less detailled to the more detailled): | For message detail level, 3 levels are available (from the less detailled to the more detailled): | ||
Line 166: | Line 183: | ||
* **Network** : Adds the gateway Rx information: //gwEui, rfRegion, rssi, lsnr, channel, radioId, antenna//. | * **Network** : Adds the gateway Rx information: //gwEui, rfRegion, rssi, lsnr, channel, radioId, antenna//. | ||
| | ||
- | \\ | + | |
== Define Connections parameters in your push configuration == | == Define Connections parameters in your push configuration == | ||
- | \\ | + | |
To define the connection parameters, you need to specify : | To define the connection parameters, you need to specify : | ||
Line 178: | Line 195: | ||
* **Data Up route**: specific route where to send push data for uplink messages | * **Data Up route**: specific route where to send push data for uplink messages | ||
* **Data Down event route**: specific route where to send push data for downlink messages | * **Data Down event route**: specific route where to send push data for downlink messages | ||
- | \\ | + | |
== Define Custom headers in your push configuration (optional) == | == Define Custom headers in your push configuration (optional) == | ||
- | \\ | + | |
If needed, you can define specific headers for your push configuration. | If needed, you can define specific headers for your push configuration. | ||
{{:wiki3:push_config_3.png?400|}} | {{:wiki3:push_config_3.png?400|}} | ||
- | \\ | + | |
- | \\ | + | |
=== Specify your push configuration for your cluster === | === Specify your push configuration for your cluster === | ||
\\ | \\ | ||
Line 202: | Line 219: | ||
{{:wiki3:create_a_cluster_2.png?800|}} | {{:wiki3:create_a_cluster_2.png?800|}} | ||
- | \\ | + | |
==== Declare your end-devices ==== | ==== Declare your end-devices ==== | ||
- | \\ | ||
Click the following link to see how to proceed: https://wmc-poc.wanesy.com/docs/administration/create-end-device.html \\ | Click the following link to see how to proceed: https://wmc-poc.wanesy.com/docs/administration/create-end-device.html \\ | ||
(if needed, replace the URL domain //wmc-poc.wanesy.com// by your own) \\ | (if needed, replace the URL domain //wmc-poc.wanesy.com// by your own) \\ | ||
{{:wiki3:create-end-device.153c5a45.gif?1000|}} | {{:wiki3:create-end-device.153c5a45.gif?1000|}} | ||
- | \\ | + | |
- | \\ | + | |
Select the "End-devices" option from the ''Administration'' menu: | Select the "End-devices" option from the ''Administration'' menu: | ||
Line 217: | Line 232: | ||
Select the ''"+"'' icon to create your end-device. | Select the ''"+"'' icon to create your end-device. | ||
- | \\ | + | |
- | \\ | + | |
=== Declare your End-device's Entity parameters === | === Declare your End-device's Entity parameters === | ||
Line 237: | Line 252: | ||
Select the ''NEXT'' button. | Select the ''NEXT'' button. | ||
- | \\ | + | |
- | \\ | + | |
=== Declare your End-device's Activation parameters === | === Declare your End-device's Activation parameters === | ||
Line 281: | Line 296: | ||
Press the ''NEXT'' button. | Press the ''NEXT'' button. | ||
- | \\ | + | |
- | \\ | + | |
=== Declare your End-device's RF parameters === | === Declare your End-device's RF parameters === | ||
Line 306: | Line 321: | ||
Press the ''NEXT'' button. | Press the ''NEXT'' button. | ||
- | \\ | + | |
- | \\ | + | |
=== Declare your End-device's Geolocation parameters === | === Declare your End-device's Geolocation parameters === | ||
Line 322: | Line 337: | ||
Press the ''VALIDATE'' button to validate all your parameters. | Press the ''VALIDATE'' button to validate all your parameters. | ||
- | \\ | + | |
- | \\ | + | |
===== Frequently Asked Questions ===== | ===== Frequently Asked Questions ===== | ||