Skip to content

Commit

Permalink
docs: Add short architecture overview
Browse files Browse the repository at this point in the history
  • Loading branch information
empicano committed Oct 4, 2023
1 parent 680f16d commit a4514db
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 2 deletions.
9 changes: 8 additions & 1 deletion docs/pages/export.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
import { Callout } from "nextra/components";

# Working with the data

The server stores measurements in the `measurement` table. This table has the following columns:
Expand Down Expand Up @@ -54,4 +56,9 @@ dataframe.pivot(

You can access the other tables in the same way, e.g. to explore configurations and logs. Please refer to the [database schema](https://github.com/iterize/tenta/blob/main/server/schema.sql) for exact details on the available tables and columns.

If your sensors send their current configuration's revision number with each measurement, you can join the `measurement` and `configuration` tables on `(sensor_identifier, revision)` to match each measurement with the associated configuration.
<Callout type="info" emoji="💡">
If your sensors send their current configuration's revision number with each
measurement, you can join the `measurement` and `configuration` tables on
`(sensor_identifier, revision)` to match each measurement with the associated
configuration.
</Callout>
6 changes: 5 additions & 1 deletion docs/pages/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
# Overview

TODO: write
Tenta consists of a server and a dashboard. The server communicates with the sensors via an intermediate MQTT broker and exposes a REST API for the dashboard. Data is stored in a PostgreSQL+TimescaleDB database.

{/* TODO: Introduce demo instance here that can be used for all following examples */}

![Diagram of Tenta's architecture](/architecture.png)
Binary file added docs/public/architecture.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit a4514db

Please sign in to comment.