Skip to content
Snippets Groups Projects
Normal view Permalink
README.md 2.18 KiB
Newer Older
philip.schell's avatar
Add CONTRIBUTING.md, LICENSE and README.md
philip.schell committed
1 
# Fraunhofer.Fit.IoT.Bots.LoraBot (Lora-Bot)
philip.schell's avatar
Update README.md and CHANGELOG.md  
philip.schell committed
2 
<!-- Short description of the project. -->
philip.schell's avatar
Add CONTRIBUTING.md, LICENSE and README.md
philip.schell committed
3
philip.schell's avatar
Update README.md and CHANGELOG.md  
philip.schell committed
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 
Program that runs on a raspberry pi and process the Lora traffic from the Lora library. This readme is meant for describing the application.

<!-- A teaser figure may be added here. It is best to keep the figure small (<500KB) and in the same repo -->

## Getting Started
<!-- Instruction to make the project up and running. -->

The project documentation is available on the [Wiki](https://github.com/MONICA-Project/lora-bot/wiki).

## Deployment
<!-- Deployment/Installation instructions. If this is software library, change this section to "Usage" and give usage examples -->

This software can not run in docker, it is made to run on real hardware (raspberry pi) with mono. This came from the [lora](https://github.com/MONICA-Project/lora) library.

## Development
<!-- Developer instructions. -->

* Versioning: Use [SemVer](http://semver.org/) and tag the repository with full version string. E.g. `v1.0.0`

### Prerequisite
This projects depends on some librarys:

#### Internal
philip.schell's avatar
Add CONTRIBUTING.md, LICENSE and README.md
philip.schell committed
27 28 29 30 31 32 33 
* BlubbFish.Utils ([Utils](http://git.blubbfish.net/vs_utils/Utils))
* BlubbFish.Utils.IoT ([Utils-IoT](http://git.blubbfish.net/vs_utils/Utils-IoT))
* BlubbFish.Utils.IoT.Bots ([Bot-Utils](http://git.blubbfish.net/vs_utils/Bot-Utils))
* BlubbFish.Utils.IoT.Connector.Data.Mqtt ([ConnectorDataMqtt](http://git.blubbfish.net/vs_utils/ConnectorDataMqtt))
* BlubbFish.Utils.IoT.Interfaces ([Iot-Interfaces](http://git.blubbfish.net/vs_utils/Iot-Interfaces))
* Fraunhofer.Fit.Iot.Lora ([Lora](https://gitlab.fit.fraunhofer.de/monica/lora-gateway/lora))
philip.schell's avatar
Update README.md and CHANGELOG.md  
philip.schell committed
34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 
#### External
* litjson


### Test

The only way to test this programm is to run it on real hardware.


### Build

Please build it with Visual Studio.

## Contributing
Contributions are welcome. 

Please fork, make your changes, and submit a pull request. For major changes, please open an issue first and discuss it with the other authors.

## Affiliation
![MONICA](https://github.com/MONICA-Project/template/raw/master/monica.png)  
This work is supported by the European Commission through the [MONICA H2020 PROJECT](https://www.monica-project.eu) under grant agreement No 732350.