summaryrefslogtreecommitdiff
path: root/README.md
blob: 356feebc3fbabd770e02607840efdc683a9aa4e2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
# iot-contact

iot-contact is an IoT device to check if doors and windows are closed or open.
Furthermore roller shutter motors should be controlled.

## Usage

The source code can be retrieved with `git`.

```
git clone https://cgit.xengineering.eu/iot-contact
cd iot-contact
git submodule update --init
```

To sign the application firmware and thus to build the project a cryptographic
signing key is required. It can be generated with `imgtool.py`.

```
mkdir ~/mcuboot
./imgtool.py keygen --key ~/mcuboot/key.pem --type ed25519
```

The project is built with the Meson build system.

```
meson setup build
ninja -C build
```

All artifacts of the build are bundled in a tar archive file.

```
tar -tf build/iot-contact-v*.tar.zst
```

This archive file can be deployed with the `deploy.py` script.

```
./build/tools/deploy.py
```