====== Setup of Wirnet™ iStation Gateway ====== ===== Documentation ===== * Leaflet (contains the list of accessories): {{ :documentation:commercial_leaflet_wirnet_istation_v3.1.pdf |}}\\ * Quick start guide: {{ :documentation:e-dmk-quick-start-guide-wirnet_istation_v11.0.pdf |}} * Web services documentation: [[https://wikikerlink.fr/wirnet-productline/doku.php?id=wiki:resources:resources#keros_web_services_documentation|click here]] \\ * SMS documentation: [[https://wikikerlink.fr/wirnet-productline/doku.php?id=wiki:resources:resources#keros_sms_documentation|click here]] * Application notes: [[https://wikikerlink.fr/wirnet-productline/doku.php?id=wiki:resources:resources#application_notes|click here]] * Software architecture: [[https://wikikerlink.fr/wirnet-productline/doku.php?id=wiki:general:software_arch|click here]] * Accessories documentations: [[https://wikikerlink.fr/wirnet-productline/doku.php?id=wiki:resources:resources#accessories_documentations|click here]] * Installation recommendations: [[https://wikikerlink.fr/wirnet-productline/doku.php?id=wiki:istation:installation_istation|click here]] **Installation of a LoRaWAN gateway shall be carefully prepared in advance to anticipate the future coverage area, QoS and make sure that all needed equipment’s are listed and are available the D-day but also to be sure that the installation is conformed to the Kerlink recommendations : {{ :documentation:an-klk03357_-_lorawan_gateways_installation_recommendations_-_v1.2.pdf | Gateways installation recommendations}}.** If you are using a cavity filter, it’s **mandatory** to connect a coaxial cable between the iStation and the cavity filter. \\ See {{ :documentation:an-klk03357_-_lorawan_gateways_installation_recommendations_-_v1.2.pdf |Gateways installation recommendations}} - Chapter 3.6.6.7 Cavity filters Kerlink found disparity in the length of the pins of the accessories that could be connected to the Wirnet™ iStation. If these pins are too long, they can mechanically permanently damage the Wirnet iStation connector internal mechanical switch that selects the internal or external antenna, thus potentially generating performance issues and preventing the later use of the internal antenna. \\ \\ If you want to connect accessories (like external antenna or surge protector)\\ and ensure the full performance and flexibility of your product, we thus strongly\\ recommend the use of **an adapter for the connector**. \\ Please read the installation guideline document : {{ :documentation:doc_guidelines_for_the_wirnet_istation_version_2023_-v0.2.pdf |}}\\ \\ **Antenna**\\ {{images:antenna_blanc.jpg?600}} \\ **Antenna with cavity filter**\\ {{images:antenna_cavity_filter_blanc.jpg?600}} \\ **Antenna with surge protection**\\ {{images:antenna_surge_protection_blanc.jpg?600}} \\ {{images:istation_connector.jpg?400}} ===== Zero Touch provisioning (ZTP) feature ===== * [[wiki:systeme_mana:ztp|Zero Touch Provisioning (ZTP)]] ===== Connection to the gateway ===== Connection to the gateway can either be done via: * SSH: [[https://wikikerlink.fr/wirnet-productline/doku.php?id=wiki:systeme_mana:connection_credentials#network_shell_access_ssh|click here]]. * Debug probe: [[https://wikikerlink.fr/wirnet-productline/doku.php?id=wiki:istation:connect_istation#connect_using_the_debug_probe|click here]]. * Web Interface: [[https://wikikerlink.fr/wirnet-productline/doku.php?id=wiki:systeme_mana:webui#Web Interface|click here]]. * USB-C: [[https://wikikerlink.fr/wirnet-productline/doku.php?id=wiki:istation:connect_istation#local_connection_usb#USB-C|click here]]. ===== Firmware update and configuration ===== A simplified upgrade method is proposed to configure the Wirnet™ Gateways with the Wanesy™ Management Center. This method is called the [[http://wikikerlink.fr/wanesy-ran/doku.php?id=wiki:wiki3:magic_link|Magic Link]]. The Magic Link is a command line, based on ''wget'' that automatically downloads the required embedded software, configures the VPN connection, configures the packet forwarder with the adapted default configuration, all in one step. ====Check the firmware version:==== Use the FAQ chapter “How to read the software version”: [[https://wikikerlink.fr/wirnet-productline/doku.php?id=wiki:support:faq#how_to_read_software_version|click here]]\\ ====Download the last firmware version:==== === Upgrade with configuration preservation=== == Upgrade from KerOS version A.x to A.y (same major version)== * Go on the KerOS firmware last version page: [[https://wikikerlink.fr/wirnet-productline/doku.php?id=wiki:firmware:lastversion|click here]]. * On the bottom of the page download the **KerOS IPK** file. * If specific files need to be preserved consult the upgrade information page: [[https://wikikerlink.fr/wirnet-productline/doku.php?id=wiki:keros_custo:upgrade#upgrade_process|click here]]. == Major version upgrade from KerOS version 4.3.3 to 5.5.4== KerOS v5.x introduces some important modifications. If some elements, like the configuration, need to be kept during the upgrade from version 4.3.3 to 5.5.4, a specific upgrade must be follow. The procedure is described on the "Major version upgrade with a custom liveburner" page: [[https://wikikerlink.fr/wirnet-productline/doku.php?id=wiki:keros_custo:upgrade_major_version|click here]]. ====Update the firmware:==== Update of the gateway's firmware can be done over Network, USB or Web interface. Use the previously downloaded IPK file (liveburner or KerOS) and follow the indication of the dedicated page Software updates: [[https://wikikerlink.fr/wirnet-productline/doku.php?id=wiki:keros_custo:sw_updates|click here]]. ===== Packet Forwarder activation and configuration ===== Kerlink provides a packet forwarder (CPF) compatible with Wirnet iStation gateways. A packet forwarder is the main program of a LoRa gateway. It has to be installed and configured to implement a LoRaWAN network. ==== Packet forwarder activation ==== Starting with Wirnet gateways firmware version v4.3.0, packet forwarder is included in the firmware. The CPF does not need to be installed. The CPF needs to be enable. To consult how to enable the CPF: [[https://wikikerlink.fr/wirnet-productline/doku.php?id=wiki:keros_custo:keros_applications_configuration|click here]]. ++++ Pre-compiled packet forwarder installation - firmware before 4.3 | * Find which is the last CPF version compatible with your gateway firmware in the compatibility matrix: [[https://wikikerlink.fr/wirnet-productline/doku.php?id=wiki:resources:resources#packet_forwarder_compatibility_matrix|click here]] * Go on the page dedicated to the CPF version needed. Quick link to the last CPF version page: [[https://wikikerlink.fr/wirnet-productline/doku.php?id=wiki:lora:cpf_last_version|click here]]. * Download the **“lorad”** and **“lorafwd”** .ipk packages files available at the end of the page. * Install the .ipk files using the instructions of the software updates page: [[https://wikikerlink.fr/wirnet-productline/doku.php?id=wiki:keros_custo:sw_updates|click here]] ++++ ==== Packet Forwarder configuration ==== Once the packet forwarder is installed on the gateway, it must be configured to be functional. * Go on the Kerlink Common Packet forwarder page and select your CPF version: [[https://wikikerlink.fr/wirnet-productline/doku.php?id=wiki:lora:cpf#installation_and_configuration|click here]]. * On the CPF configuration page look at the chapter "How to configure and monitor the packet forwarder?" ===== Factory reset ===== If needed the factory reset of the gateway is feasible. Consult the stock restore process: [[https://wikikerlink.fr/wirnet-productline/doku.php?id=wiki:systeme_mana:features#stock_restore|click here]] ===== Get the logs ===== To simplify the log gathering process, Kerlink developed automatic log gathering methods. Consult the Automatic log gathering chapter: [[https://wikikerlink.fr/wirnet-productline/doku.php?id=wiki:support:troubleshoot#automatic_log_gathering|click here]] ===== Connect an iStation to WMC ===== * Please contact Kerlink Support team at [[support@kerlink.fr]] to get a Magic Link to update the gateway with the relevant firmware and embedded applications. * [[https://wikikerlink.fr/wanesy-ran/doku.php?id=wiki:wiki3:quickstart|How to connect a gateway to WMC?]] ===== Connect an iStation to AWS IoT Core ===== See [[wiki:lora:basic_station_forwarder#aws_lns_configuration_tool|AWS LNS configuration tool]] ===== Connect an iStation to The Things Network ===== See [[wiki:lora:basic_station_forwarder#ttn_lns_configuration_tool|TTN LNS configuration tool]] ===== Connect an iStation to Loriot ===== See [[wiki:lora:basic_station_forwarder#loriot_lns_configuration_tool|Loriot LNS configuration tool]] ===== Connect an iStation to ChirpStack ===== [[https://wikikerlink.fr/wirnet-productline/doku.php?id=wiki:keros_custo:keros_applications_configuration#connect_a_wirnet_i-series_gateway_to_chirpstack|How to connect a gateway to ChirpStack?]] ===== LoRaWAN protocol ===== Kerlink is a member of LoRa Alliance and the Kerlink gateway is compatible with LoRaWAN protocol. If you need information about LoRaWAN network protocol please contact the LoRa Alliance and request LoRaWAN specification : [[https://lora-alliance.org/lorawan-for-developers]] ===== Register to wiki update notifications ===== You can register for Wiki update notifications by clicking on the envelope icon (“Manage subscriptions”) on the right side of the page. ===== Administrative information ===== [[https://wikikerlink.fr/faq/doku.php?id=home#administrative_information|Administrative information]]