User Tools

Site Tools


wiki:wiki3:quickstart

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
wiki:wiki3:quickstart [2020/09/22 17:42]
ghi
wiki:wiki3:quickstart [2023/10/06 09:24] (current)
ehe [Install the Gateway Software]
Line 1: Line 1:
 ====== QuickStart of Wanesy Management Center (WMC) ====== ====== QuickStart of Wanesy Management Center (WMC) ======
-\\+ 
 +[[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]] 
-\\+  * Commercial leaflet: {{ :​wiki3:​wanesy_management_plane_commercial_leaflet_v3.2.12.pdf|}} 
 +===== Zero Touch provisioning (ZTP) feature ===== 
 + 
 +  * [[https://​wikikerlink.fr/​wirnet-productline/​doku.php?​id=wiki:​systeme_mana:​ztp|Zero Touch Provisioning (ZTP)]]
 ===== 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 23: Line 28:
 {{:​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...)
-\\ + 
-These packages are brought together into a single package called a **"​megapackage**"​. ​\\ +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. 
-This specific software is also called the "​**embedded software**"​. ​\\ \\ + 
-The version of the megapackage to install depends on the WMC software release.+<note important>​  
 +**Starting from version 4.3, KerOS firmware is delivered with Kerlink Common Packet Forwarder and WMC Embedded applications. No megapackage is needed. 
 +These applications ​ (Packet Forwarder, BSCC, and SNMP) are disabled by default and need to be enabled to use the gateways on WMC.** 
 +</​note> ​
  
 Click on the line that matches your WMC version: Click on the line that matches your WMC version:
  
-  ​* [[http://​wikikerlink.fr/​wanesy-ran/​doku.php?​id=wiki:​wiki3:​gateway_sw_3.0|Gateway ​Software ​Releases for WMC v3.0]] +^ WMC version ^ KerOS products ^ Wirnet Station ^ 
-  * [[http://​wikikerlink.fr/​wanesy-ran/​doku.php?​id=wiki:​wiki3:​gateway_sw_3.1|Gateway ​Software ​Releases for WMC v3.1]] +**WMC 3.2** | ​[[https://​wikikerlink.fr/​wanesy-ran/​doku.php?​id=wiki:​wiki3:​gateway_sw_5.9|Wirnet i-series ​Software ​Release v5.9]] | [[http://​wikikerlink.fr/​wanesy-ran/​doku.php?​id=wiki:​wiki3:​gateway_sw_wista_3.1.8|Wirnet Station embedded sofware 3.1.8]] | 
-  * [[http://​wikikerlink.fr/​wanesy-ran/​doku.php?​id=wiki:​wiki3:​gateway_sw_3.2|Gateway ​Software ​Releases for WMC v3.2]] +**WMC 3.2** | ​[[http://​wikikerlink.fr/​wanesy-ran/​doku.php?​id=wiki:​wiki3:​gateway_sw_4.3.3|Wirnet i-series ​Software ​Release v4.3.3]] | [[http://​wikikerlink.fr/​wanesy-ran/​doku.php?​id=wiki:​wiki3:​gateway_sw_wista_3.1.8|Wirnet Station embedded sofware 3.1.8]] | 
-  * [[http://​wikikerlink.fr/​wanesy-ran/​doku.php?​id=wiki:​wiki3:​gateway_sw_3.3|Gateway ​Software ​Releases for WMC v3.3]] +**WMC 3.1** | ​[[http://​wikikerlink.fr/​wanesy-ran/​doku.php?​id=wiki:​wiki3:​gateway_sw_3.1|Embedded ​Software ​Release ​v3.1.4]] | [[http://​wikikerlink.fr/​wanesy-ran/​doku.php?​id=wiki:​wiki3:​gateway_sw_3.1|Wirnet Station embedded sofware 3.1.6]] | 
-\\ +**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:
  
-  ​* [[https://​wikikerlink.fr/​wanesy-ran/​doku.php?​id=wiki:​wiki3:​faq_gw_first_install_3.0|Gateway Software Install WMC 3.0]] +^WMC version ^ Embedded Software Version ^  
-  * [[https://​wikikerlink.fr/​wanesy-ran/​doku.php?​id=wiki:​wiki3:​faq_gw_first_install_3.1|Gateway Software Install WMC 3.1]] +**WMC 3.2** | ​[[https://​wikikerlink.fr/​wanesy-ran/​doku.php?​id=wiki:​wiki3:​faq_gw_first_install_3.2|Gateway Software Install WMC 3.2]] |  
-  [[https://​wikikerlink.fr/​wanesy-ran/​doku.php?​id=wiki:​wiki3:​faq_gw_first_install_3.2|Gateway Software Install ​WMC 3.2]] +**WMC 3.1** | ​[[https://​wikikerlink.fr/​wanesy-ran/​doku.php?​id=wiki:​wiki3:​faq_gw_first_install_3.1|Gateway Software Install WMC 3.1]] | 
-  ​* [[https://​wikikerlink.fr/​wanesy-ran/​doku.php?​id=wiki:​wiki3:​faq_gw_first_install_3.2|Gateway Software Install WMC 3.3]] +| **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 67: Line 75:
  
 https://​wmc-poc.wanesy.com/​docs/​administration/​create-customer.html \\ https://​wmc-poc.wanesy.com/​docs/​administration/​create-customer.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-customer.1788d778.gif?​1000|}} {{:​wiki3:​create-customer.1788d778.gif?​1000|}}
 \\ \\
Line 78: Line 86:
  
 Click the following link to see how to proceed: https://​wmc-poc.wanesy.com/​docs/​administration/​create-fleet.html \\ Click the following link to see how to proceed: https://​wmc-poc.wanesy.com/​docs/​administration/​create-fleet.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-fleet.b46d770c.gif?​1000|}} ​ {{:​wiki3:​create-fleet.b46d770c.gif?​1000|}} ​
-\\ +
-\\+
 ==== Declare your gateways ==== ==== Declare your gateways ====
  
Line 87: Line 94:
  
 Click the following link to see how to proceed: https://​wmc-poc.wanesy.com/​docs/​administration/​create-gateway.html \\ Click the following link to see how to proceed: https://​wmc-poc.wanesy.com/​docs/​administration/​create-gateway.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-gateway.cb366729.gif?​1000|}} {{:​wiki3:​create-gateway.cb366729.gif?​1000|}}
  
Line 119: Line 126:
  
  
-\\ 
-\\ 
 ==== Create your clusters ==== ==== Create your clusters ====
  
Line 127: Line 132:
  
 Click the following link to see how to proceed: https://​wmc-poc.wanesy.com/​docs/​administration/​create-cluster.html \\ Click the following link to see how to proceed: https://​wmc-poc.wanesy.com/​docs/​administration/​create-cluster.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-cluster.c902f420.gif?​1000|}} {{:​wiki3:​create-cluster.c902f420.gif?​1000|}}
  
Line 135: Line 140:
   * 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:
  
 Click the following link to see how to proceed: https://​wmc-poc.wanesy.com/​docs/​administration/​create-push-configuration.html ​ \\ Click the following link to see how to proceed: https://​wmc-poc.wanesy.com/​docs/​administration/​create-push-configuration.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-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 154: Line 160:
   * **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 160: Line 169:
     * **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 172: Line 181:
   * **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 196: Line 205:
  
 {{:​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 211: Line 218:
  
 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 228: Line 235:
   * **Regional parameters revision** (mandatory):​ A,B, C   * **Regional parameters revision** (mandatory):​ A,B, C
  
-For details about these parameters, please read the LoRaWAN® Regional Parameters from the LoRa Alliance: [[https://​lora-alliance.org/​resource-hub/lorawanr-regional-parameters-v102rb|LoRaWAN® Regional Parameters v1.0.2rB]]+For details about these parameters, please read the LoRaWAN® Regional Parameters from the LoRa Alliance: [[https://​lora-alliance.org/​resource_hub/rp2-1-0-3-lorawan-regional-parameters/|LoRaWAN® Regional Parameters v1.0.3RP2]]
  
 Select the ''​NEXT''​ button. Select the ''​NEXT''​ button.
-\\ + 
-\\+
 === Declare your End-device'​s Activation parameters === === Declare your End-device'​s Activation parameters ===
  
Line 252: Line 259:
  
   * **Device EUI** (mandatory):​ a global end-device ID in IEEE EUI64 address space that uniquely identifies the end-device.   * **Device EUI** (mandatory):​ a global end-device ID in IEEE EUI64 address space that uniquely identifies the end-device.
-  * **Application EUI** (mandatory): a global application ID in IEEE EUI64 address space that uniquely identifies 1318 the Join Server that is able to assist in the processing of the Join procedure and the session keys derivation. +  * **Application EUI**: a global application ID in IEEE EUI64 address space that uniquely identifies 1318 the Join Server that is able to assist in the processing of the Join procedure and the session keys derivation. 
-  * **Application key** (mandatory) ​: is a AES-128 root key specific to the end-device that is assigned to the end-device during fabrication.+  * **Application key** : is a AES-128 root key specific to the end-device that is assigned to the end-device during fabrication.
   * **DevNonceCounter**:​ Enable or Disable.   * **DevNonceCounter**:​ Enable or Disable.
    
Line 275: Line 282:
  
 Press the ''​NEXT''​ button. Press the ''​NEXT''​ button.
-\\ + 
-\\+
 === Declare your End-device'​s RF parameters === === Declare your End-device'​s RF parameters ===
  
Line 287: Line 294:
 Read the following wiki page to get details about the settings of the [[https://​wikikerlink.fr/​wanesy-ran/​doku.php?​id=wiki:​wiki3:​network_delays | network delays]]. Read the following wiki page to get details about the settings of the [[https://​wikikerlink.fr/​wanesy-ran/​doku.php?​id=wiki:​wiki3:​network_delays | network delays]].
  
- +{{:wiki3:create_end_device_override_parameters.png?800|}}
-{{:wiki3:create_a_end_device_4.png?800|}}+
  
      * **RX1 delay**: delay for the first receive window RX1.       * **RX1 delay**: delay for the first receive window RX1. 
Line 295: Line 301:
      * **RX1DROffset**:​ sets the offset between the uplink data rate and the downlink data 1640 rate used to communicate with the end-device on the first reception slot (RX1).      * **RX1DROffset**:​ sets the offset between the uplink data rate and the downlink data 1640 rate used to communicate with the end-device on the first reception slot (RX1).
      * **RX windows**: RX1, RX2 or Auto.      * **RX windows**: RX1, RX2 or Auto.
 +     * **CF List**: The join-accept optional CFList (**C**hannel **F**requency **List**) is a list of channel frequencies or a list of channel masks given to end-devices. If present, the CFList replaces all the previous channels stored in the end-device apart from the default channels. The newly defined channels are immediately enabled and usable by end-devices for communication. The WMC will use by default a CFList based on the gateways channels. If the use of a specific channel list is needed, complete these fields.
 +     * **Dwell Time**: Check this box to respect dwell time regulation. The dwell time is the maximum duration of the messages. The box is only visible for Regions in which regulation can impose to respect a dwell time limitation (max 400ms duration). ​
  
-For details about the settings of RX1, RX2 parameters, please read the LoRaWAN® Regional Parameters from the LoRa Alliance: [[https://​lora-alliance.org/​resource-hub/lorawanr-regional-parameters-v102rb|LoRaWAN® Regional Parameters v1.0.2rB]]+For details about the settings of RX1, RX2 parameters, please read the LoRaWAN® Regional Parameters from the LoRa Alliance: [[https://​lora-alliance.org/​resource_hub/rp2-1-0-3-lorawan-regional-parameters/|LoRaWAN® Regional Parameters v1.0.3RP2]]
  
 Press the ''​NEXT''​ button. Press the ''​NEXT''​ button.
-\\ + 
-\\+
 === Declare your End-device'​s Geolocation parameters === === Declare your End-device'​s Geolocation parameters ===
  
Line 315: Line 323:
  
 Press the ''​VALIDATE''​ button to validate all your parameters. Press the ''​VALIDATE''​ button to validate all your parameters.
-\\ + 
-\\+
 ===== Frequently Asked Questions ===== ===== Frequently Asked Questions =====
  
wiki/wiki3/quickstart.1600789335.txt.gz · Last modified: 2020/09/22 17:42 by ghi