lorawan-node-simulator

KO | EN

gitlite — search

#hacktoberfest #ai #llm #golang #android #linux #macos #nodejs #windows #cli #vue #awesome-list #pytorch #open-source

lorawan-node-simulator

(★ 109)

Simulation infrastructure for a LoRaWAN network (gatways and end devices) that's easy to configure and run from your CLI. Also available as a Docker container.

파일 탐색기

최종 버전 다운로드 (.zip)

- - nodejs-ci.yml
- launch.json
- tasks.json
- end-node-otaa.js
- end-node-otaa.js.map
- end-node.js
- end-node.js.map
- gateway.js
- gateway.js.map
- index.js
- index.js.map
- end-node-otaa.ts
- end-node.ts
- gateway.ts
- index.ts
- environment.d.ts
- packet-forwarder.d.ts
.dockerignore
.env.sample
.gitignore
docker-compose.yml
Dockerfile
LICENSE
package-lock.json
package.json
README.md
tsconfig.json

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Welcome to lorawan-node-simulator 👋

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://raw.githubusercontent.com/kartben/lorawan-node-simulator/master/LICENSE)
[![Twitter: kartben](https://img.shields.io/twitter/follow/kartben.svg?style=social)](https://twitter.com/kartben)
[![Build](https://github.com/kartben/lorawan-node-simulator/workflows/Node.js%20CI/badge.svg)](https://github.com/kartben/lorawan-node-simulator/actions?query=workflow%3A"Node.js+CI")

This repository contains a simulation infrastructure for LoRaWAN.

It simulates LoRaWAN gateways, and endpoints regularly emitting LoRaWAN radio packets ("Unconfirmed Data Uplink" by default). These packets get picked up by a few (i.e. 1 to 3) gateways that forward them to a network server.

As the initial purpose of this solution was to stress test a LoRaWAN network server, and not necessarily implement a full-blown simulator, only uplink traffic is generated at this point, and devices are expected to be provisioned via ABP.

## Install

```bash
npm install lorawan-node-simulator -g
```

## Usage

The simulator needs to be configured using the following environment variables (the ones in **bold** are mandatory):

- **`NETWORK_SERVER_URI`**: (ex: udp://ttnv3-myinstance.eastus.cloudapp.azure.com:1700) ;
- **`NETWORK_SESSION_KEY`**:  The network session key (NwkSKey) used by the simulated devices (ex: A54FA689EED2DCE45A4CE5CD947EFCB7) ;
- **`APPLICATION_SESSION_KEY`**:  The application session key (AppSKey) used by the simulated devices (ex: D8B3FEE5D99EFCFE924678DD664E160C) ;
- `GATEWAY_START_EUI`: EUI of the first gateway to simulate, 32 hex digits (default: 0000000000000001);
- `GATEWAY_END_EUI`: EUI of the last (inclusive) gateway to simulate, 32 hex digits (default: 0000000000000005);
- `END_NODE_START_DEVADDR`: DevAddr of the first end node to simulate, 8 hex digits (default: 00000000);
- `END_NODE_END_DEVADDR`: DevAddr of the last (inclusive) end node to simulate, 8 hex digits (default simulation has 1000 devices, hence end address is 000003E8).
- `END_NODE_TX_PERIOD`: how often the end nodes transmit, in milliseconds (default: 30000, i.e. 30s) ;

Once all the required environment variables have been set (defined globally in your environment, or in a `.env` file in the folder from where you'll run the command, in which case you may want to rename the `.env.sample` file and use it as a starting point), simply launch the simulation:

```bash
lorawan-node-simulator
```

### Docker container

The simulator is also available as a Docker container.

```bash
docker run kartben/lorawan-node-simulator
```

## Pre-requisites / Limitations

- The simulator does *not* provision the simulated gateways, end devices and applications in your network server so you must take care of doing so prior to launching a simulation ;

- The application payload is hard-coded and the same for all devices (4 bytes: ['t', 'e', 's', 't']) ;

- Gateways need to be provisioned with an "EU 863-870" frequency plan. Note that adding support for additional frequency plans in the simulator is reasonably straigthforward ;

- Devices need to be provisioned in your network server using the ABP method, and need to be in a "vanilla" state (i.e. frame counter = 0) ;

- Devices only emit unconfirmed uplink at the moment ;

- All simulated devices need to have the same NwkSKey and AppSKey (which may not be a recommened practice in a real-world environment!) ;

- No downlink support (the packet forwarder that the simulated gateways implement only supports "PUSH_DATA" command from the Semtech packet forwarder specification at the moment, so downlink can't be available) ;

## Author

👤 **Benjamin Cabé**

* Website: https://blog.benjamin-cabe.com
* Twitter: [@kartben](https://twitter.com/kartben)
* Github: [@kartben](https://github.com/kartben)
* LinkedIn: [@benjamincabe](https://linkedin.com/in/benjamincabe)

## 🤝 Contributing

Contributions, issues and feature requests are welcome!

Feel free to check [issues page](https://github.com/kartben/lorawan-node-simulator/issues).

## Show your support

Give a ⭐️ if this project helped you!

## 📝 License

This project is [MIT](/LICENSE) licensed.

***
_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_

lorawan-node-simulator

파일 탐색기

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

lorawan-node-simulator

파일 탐색기

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README