2024-07-17 12:28:31 +02:00

34 lines
1.6 KiB
Markdown

# IOTTB
Hello! This is the README file that accompanies the Gitlab repository for your Bachelor or Master thesis. You'll need to update this README as you work on your thesis to reflect relevant information about your thesis.
[[_TOC_]]
## Organization of the repository
- **code** folder: holds source code
- **data** folder: Holds no relevant data for this thesis. Files in here where used for debugging and testing.
- **results** folder: holds results files generated as part of the project
- **thesis** folder: contains the latex sources + PDF of the final thesis.
- **presentation** folder: contains the sources of the presentation.
- **literature** used can be found in the **thesis** folder .bib or in the **presentation** folders .bib file.
- **notes** folder: Various notes and the beginnings of a wiki.
- `iottb` is the python testbed as a single executable (includingn python interpreter) which should be able to run on Linux machines.
## Description
In this thesis I design a automation testbed for IoT devices.
The main result is the software `iottb` which automates some aspects of experimenting with IoT devices.
Currently it implements a database guided by the FAIR principles of open data as well as wraps tcpdump such that metadata is stored.
## Usage
For more info see `code/iottb-project/README.md`.
As well as examples in the thesis writeup at `thesis/BScThesisUnibas_main-5.pdf`. <br>
In general:
```bash
iottb --help # Most general overview
iottb <subcommand> --help
```
## License
This project is licensed under the BSD 3-clause License, a copy of which is provided in the file `LICENSE` in the root of this project.