codex

README

codex

Codex provides a historical context about devices connected to XMiDT.

Summary

Codex accepts incoming events, stores them in a postgres database, and provides event information by device id. This repo is a library of packages used to implement codex.

The Pieces

• Database: Any postgres database will work. In deploy/, cockroachdb is used.
• Svalinn: Registers to an endpoint to receive events (Optional). Has an endpoint that receives events as WRP Messages, parses them, and inserts them into the database.
• Gungnir: Has endpoints that provide device information from the database.
• Fenrir: Deletes old records from the database at an interval.

Install

This repo is a library of packages used for the codex project. There is no installation. To install each service, go to their respective READMEs.

Deploy

for deploying the project in Docker, refer to the deploy README.

Contributing

Refer to CONTRIBUTING.md.