Status | Date | Doc Version | Applicable | Confidentiality |
RELEASED | 12 Jul 2024 | v1.0 | Wirepas 5G Mesh | PUBLIC |
Introduction
Welcome to the entry-point to start experimenting with Wirepas 5G Mesh technology!
This document is targeted at new developers starting with Wirepas 5G Mesh.
A Wirepas Software License is required to access Wirepas 5G Mesh software and build Wirepas applications. Please contact your Wirepas sales representative to request a license if you don’t yet have one.
Get to know Wirepas 5G Mesh
Before any practical implementation of a Wirepas 5G Mesh network, we recommend you to go through the following documents the get knowledge on Wirepas 5G Mesh, how it works and how the APIs are organized:
- Wirepas 5G Mesh Overview [1]
- Wirepas 5G Mesh - How it works [2]
- Wirepas Software and APIs Overview [3]
Once you are familiar with Wirepas 5G Mesh and associated APIs, you can start to go through our different guides in the order presented in the following sections.
Set up the Wirepas development environment
The first step in the journey is to download and install your build environment to work with Wirepas 5G Mesh network.
The setup system consists of the following development environment:
- Wirepas Binaries (modem radio firmware, stack and bootloader) to be able to compile a user application (under License)
- Wirepas SDK to ease up application development and to allow code compilation
- Chip vendor binary programming toolchain to flash your compiled application into your devices
- (Optionally) Wirepas Network Tool (WNT) backend (either hosted by Wirepas or by you) and WNT Client to monitor the Wirepas Mesh network. Note that WNT backend tools are to be used for Evaluation purposes only. NMS Tool will be available later this year (2024)
Create your first Wirepas 5G Mesh network
We have written a set of step-by-step Tutorial to help you to get familiar with the Wirepas 5G Mesh network development and the setup process. The document put into practice all the concepts and terminology seen in the previous documents. It will walk you through all the steps needed to build your first network and communicate with it.
Please note that you will need some hardware at this stage. The required hardware options are listed in the Hardware Reference guide [4].
- How To set up and use your first Wirepas 5G Mesh network [5]
- This document describes how to build a small network and communicate with it using Wirepas Gateway.
Once you have completed this tutorial, you have completed the Wirepas 5G Mesh Getting Started. Congratulations!!
You should now have a better understanding of the whole Wirepas 5G Mesh architecture i.e. “network + gateway + backend” and know the basics of communicating with a Wirepas network via a gateway.
It is now time to start to develop your own product!
Start to develop your own network
Now that you have configured your first Wirepas 5G Mesh network you can start to design your own application and network infrastructure.
All the documentation related to Wirepas 5G Mesh can be found in the “Wirepas Mesh documentation“ section of the developer portal [6].
References
[1] Wirepas 5G Mesh Overview
[2] Wirepas 5G Mesh Concepts
[3] Wirepas Software and APIs Overview
[4] Hardware Reference Manual
[5] Your first 5G Mesh Network
[6] Wirepas Mesh related documentation
Revision History
Date | Version | Notes |
12 Jul 2024 | v1.0 | Initial version |
Legal Notice
Use of this document is strictly subject to Wirepas’ Terms of Use and Legal Notice.
Copyright © 2024 Wirepas Oy