README.md


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
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63

# The mock server for AIRMX Pro

[![Test](https://github.com/openairmx/server/actions/workflows/test.yml/badge.svg)](https://github.com/openairmx/server/actions/workflows/test.yml)
[![MIT License](https://img.shields.io/github/license/openairmx/server)](https://github.com/openairmx/server)

This repository contains a mock server used to enable AIRMX Pro devices to
communicate. The server allows devices to register themselves with an MQTT
server, periodically synchronize the date and time, and facilitate device
pairing.

> [!WARNING]
> Due to the lack of the authentication feature, the code is expected to be run
> on your internal network.

## Usage

We’re keeping things simple at heart while building it; the server has zero
dependencies, so we don’t need to install anything. All you need is to spin
up the server with:

```
node server.mjs
```

You should see _Listening on 0.0.0.0:80_. To customize the listening host
or port, you can use the following two environment variables:

```
HOSTNAME="127.0.0.1" PORT=8080 node server.mjs
```

## Endpoints

<dl>
  <dt>GET /gettime</dt>
  <dd>
    From time to time, your AIRMX Pro will hit this endpoint to update its
    local datetime, and we’re simply returning the current timestamp in
    seconds back to the device.
  </dd>

  <dt>GET /eagle</dt>
  <dd>
    During the pairing process, when the device receives the Wi-Fi credentials
    you provide, it registers itself with this endpoint along with its MAC
    address and encryption key, which is the token that allows you to control
    your device remotely later. We store this device information in an
    in-memory SQLite database and wait for you to exchange your device key at
    the final stage of the pairing process.
  </dd>

  <dt>GET /exchange</dt>
  <dd>
    To streamline device pairing, we introduce an unofficial API that enables
    you to directly retrieve your device key from the browser. However, it's
    crucial to understand that this API lacks authentication and will exchange
    your device encryption key based solely on the device ID.
  </dd>
</dl>

## License

The code is released under [the MIT license](LICENSE.md).