This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
wiki:gateway_configuration [2018/04/30 16:08] mpe old revision restored (2017/12/01 11:50) |
— (current) | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== Gateway configuration ====== | ||
- | |||
- | To use an end-device with SPN, the end-device and the gateway need to use the same parameters. | ||
- | Some parameters are common to the entire fleet and some parameters are end-device specific. | ||
- | |||
- | ===== Generic LoRa configuration ===== | ||
- | |||
- | Generic LoRa configuration is done via the //configuration// menu. | ||
- | |||
- | {{:images:configuration_menu.png?100|}} | ||
- | |||
- | ==== Regional parameters ==== | ||
- | |||
- | Depending on regions, the LoRaWAN specification differs. The ISM band ranges can be selected in the //Region// menu. The list of available //Region// depends of the hardware capabilities. | ||
- | |||
- | {{ :images:region_configuration.png?550 |}} | ||
- | |||
- | ==== RX configuration ==== | ||
- | |||
- | The iFemtoCell cannot listen to all frequencies simultaneously. Up to 8 frequencies can be configured. | ||
- | |||
- | To understand how the frequency configuration works, it is necessary to know that the Wirnet iFemtoCell’s hardware contains two RF front-ends. Each of these front-ends has a 0.8 MHz Bandwidth. Thus, all 8 channels must be contained within these two 0.8 MHz intervals. | ||
- | |||
- | To properly configure the Rx channels, the center frequencies of the front-ends must be defined. | ||
- | |||
- | Once the center frequencies are defined, each channel can be configured. | ||
- | |||
- | Here are a few rules/information to configure the frequencies: | ||
- | |||
- | * Both front-ends are not necessarly used. | ||
- | * Both front-end's bandwidth can overlap. | ||
- | * Channels can overlap. | ||
- | * All 8 frequencies can be contained within one single front-end's bandwidth. | ||
- | * Not all 8 frequencies are necessarily used. | ||
- | * Avoid the use of the front-end center frequency as a channel. | ||
- | |||
- | Example of typical configuration for 868MHz band (868.1MHz, 868.3MHz and 868.5MHz are mandatory in most countries using 868MHz end-devices): | ||
- | {{ :wiki:typical_rx_config_v1.1.png?nolink |}} | ||
- | |||
- | Example of all 8 frequencies contained within one 0.8MHz interval: | ||
- | |||
- | {{ :wiki:one_bandwitdth_rx_config_v1.1.png?nolink |}} | ||
- | |||
- | ==== Tx configuration ==== | ||
- | |||
- | The transmission power must be configured to fit country-specific regulation. | ||
- | |||
- | The maximum transmission power can be expressed in EIRP (Equivalent Isotropically Radiated Power) or ERP (Effective Radiated Power). | ||
- | * EIRP is the radiated output power refereced to an isotropic antenna radiating power equally in all directions and whose gain is expressed in dBi. | ||
- | |||
- | * ERP is referenced to a half-wave dipole antenna whose gain is expressed in dBd => ERP = EIRP - 2.15 dB. | ||
- | |||
- | In the gateway configuration page, the maximum TX power is set in dBm (EIRP). For information the theoretical ERP is also available. | ||
- | |||
- | The antenna gain needs to be configured. When sending TX messages the gateway will take into account this gain to respect the maximun emitted power. The LoRa antennas provide with the Wirnet iFemtoCell are 3 dBi antennas. | ||
- | |||
- | If a end-device is close to the Wirnet iFemtoCell, it is recommended to decrease the TX power to avoid saturation and desensitization of the LoRa receiver. | ||
- | |||
- | {{ :images:tx_configuration.png?700 |}} | ||
- | |||
- | ==== LoRa network ID ==== | ||
- | |||
- | The //LoRa network// page only allows you to choose your LoRa ''NwkID''. The LoRa ''NwkID'' is applicable only for an OTAA fleet. | ||
- | |||
- | {{ :images:loranetwork.png?600 |}} | ||
- | |||
- | NwkID range value: ''0-127''. | ||
- | |||
- | <note important>After changing the network ID, you need to reboot the gateway</note> | ||
- | |||
- | <note important>Be careful, once ''NwkID'' is updated, OTAA devices already activated must initiate another join procedure to communicate again with the new ''NwkID''.</note> | ||
- | |||
- | |||
- | |||
- | Kerlink recommends to configure the LoRa ''NwkID'' before adding your end-devices to the fleet. | ||
- | |||
- | |||
- | ==== Import / Download gateway configuration ==== | ||
- | |||
- | Gateway configuration can be import or download via the // Main configuration // tab under the // Administration // menu. Download your current configuration will give you a template to make your new configuration. | ||
- | |||
- | {{ :images:importconfiguration_v1.1.1.png?700 |}} | ||
- | |||
- | <note tip> | ||
- | Once your gateway is configured, you can download the configuration in order to make a backup. | ||
- | </note> | ||
- | |||
- | Field description is available here: [[wiki:data_json|Data JSON file]] | ||
- | |||
- | |||
- | |||
- | |||
- | ===== End-device parameters ===== | ||
- | |||
- | Every end-device needs to be configured/registered. This configuration is done via the //manage endpoints// tab under the //Endpoints// menu. End-devices can be added one by one manually in your end-device fleet or with a CSV file. | ||
- | |||
- | <note important>The configuration of an end-device cannot be edited. To change the configuration you need to delete this end-device and re-create it. This will **delete all received data** from this end-device.</note> | ||
- | |||
- | |||
- | <note tip> | ||
- | It is also possible to download your current fleet to make a backup. | ||
- | </note> | ||
- | ==== Class ==== | ||
- | |||
- | SPN handles two kind of LoRa class functionality: class A and class C. | ||
- | The main difference between class A and C is that a class C device can receive data from the gateway at almost any time whereas the class A device can only receive data for a short duration after it emitted a packet. For more information about LoRa classes, refer to the [[https://www.lora-alliance.org/|LoRaWan specification]]. | ||
- | |||
- | ==== Activation parameters ==== | ||
- | |||
- | To communicate, an end-device needs to be activated on the station. There are two types of activation: OTAA (Over-The-Air Activation) and ABP (Activation by Personalization). | ||
- | |||
- | === If the end-device uses OTAA === | ||
- | |||
- | For over-the-air activation, end-devices must follow a join procedure prior to participating in data exchanges with the network server. An end-device has to go through a new join procedure every time it has lost the session context information. The join procedure requires the end-device to be personalized with the following information before its starts the join procedure: | ||
- | |||
- | * A globally unique end-device identifier: ''DevEUI''. | ||
- | * The application identifier: ''AppEUI''. | ||
- | * An AES-128 key: ''AppKey''. | ||
- | |||
- | This information is used at each join procedure to derive unique session keys (''NwkSKey'', ''AppSKey''). These keys are then used to exchanged data between the end-device and the gateway. | ||
- | |||
- | {{ :images:otaadeclaration.png?600 |}} | ||
- | |||
- | === If the end-device uses ABP === | ||
- | |||
- | Activating an end-device by personalization means that the ''DevAddr'' and the two session keys (''NwkSKey'' and ''AppSKey'') are directly stored into the end-device instead of the DevEUI, AppEUI and the AppKey. The end-device is equipped with the required information for participating in a specific LoRa network when started. | ||
- | |||
- | |||
- | {{ :images:abp_declaration.png?600 |}} | ||
- | |||
- | ==== LoRa RF parameters ==== | ||
- | When a packet is sent by an end-device, the end-device opens two reception windows. The first window uses the same channel than the one used to send the frame. The second window uses a predefined frequency. During these windows, a frame send by the station can be received. | ||
- | |||
- | By default, SPN automatically choses which window is used. When the second window is used, by default, the packet is sent at the frequency 869,525MHz with the datarate "0". | ||
- | |||
- | If this configuration is not desired, it can be overridden using the //Override default Rx parameters// check box. | ||
- | |||
- | {{ :images:ep_lorarfparameters.png?600 |}} | ||
- | |||
- | ==== Import a fleet with a CSV file ==== | ||
- | |||
- | === File format === | ||
- | |||
- | __Fleet_import_template:__ | ||
- | <file csv Fleet_Import_Template_v1.1.1.csv> | ||
- | activation_type,class,dev_eui,app_eui,app_key,dev_addr,nwks_key,apps_key,rx_window,rx_frequency,rx_datarate,status | ||
- | </file> | ||
- | |||
- | |||
- | __Fields description:__ | ||
- | |||
- | {{ :images:import_fleet_v1.1.1.png?350|}} | ||
- | |||
- | *''activation_type'': ''OTAA'' or ''ABP''. | ||
- | * ''class'': Class of the end-device''A'' or ''C''. | ||
- | * ''dev_eui'': Device EUI. | ||
- | * Only for OTAA end-devices. Leave empty if the activation type is ABP. | ||
- | * ''app_eui'': Application EUI. | ||
- | * Only for OTAA end-devices. Leave empty if the activation type is ABP. | ||
- | * ''app_key'': Application key (only for OTAA device). | ||
- | * Only for OTAA end-devices. Leave empty if the activation type is ABP. | ||
- | * ''dev_addr'': Device address. | ||
- | * Only for ABP end-devices. Leave empty if the activation type is OTAA. | ||
- | * ''nwks_key'': Network Session Key. | ||
- | * Only for ABP end-devices. Leave empty if the activation type is OTAA. | ||
- | * ''apps_key'': Application Session Key. | ||
- | * Only for ABP end-devices. Leave empty if the activation type is OTAA. | ||
- | * ''rx_window'': | ||
- | * Window 1: ''0''. | ||
- | * Window 2: ''1''. | ||
- | * Automatic window: ''255''. | ||
- | * ''rx_frequency'': Frequency value in Hz (example 869525000). | ||
- | * ''rx_datarate'' : Integer value of the datarate. | ||
- | * ''status'' : Set to UNKNOWN. | ||
- | |||
- | <note important> | ||
- | Status field is not implemented in version v1.1.1. Set the field to UNKNOWN. | ||
- | </note> | ||
- | |||
- | === Example === | ||
- | |||
- | <file csv Fleet_Import_Example_v1.1.1.csv> | ||
- | activation_type,class,dev_eui,app_eui,app_key,dev_addr,nwks_key,apps_key,rx_window,rx_frequency,rx_datarate,status | ||
- | OTAA,A,0018B20000000BAA,0018B20041524632,0018B244415246320018B20000000BAA,,,,255,869525000,0,UNKNOWN | ||
- | ABP,C,,,,00001233,98765432109876543210987654321098,98765432109876543210987654321098,1,869525000,3,UNKNOWN | ||
- | </file> | ||
- | |||
- | ==== Delete your end-devices ==== | ||
- | |||
- | === One by one === | ||
- | {{ :images:bin.png?40|}} | ||
- | It is possible to delete end-devices one by one. Select your end-device in the list under the //Endpoints// menu and click on the bin icon. | ||
- | |||
- | |||
- | |||
- | === All the fleet === | ||
- | {{ :images:deleteendpoints_v1.1.1.png?300|}} | ||
- | To remove all the fleet use the available button in the //manage endpoints// tab. | ||
- | |||