Skip to content

dbrgn/smartmail

Repository files navigation

smartmail

CircleCI

This is a "smart mailbox" based on LoRaWAN and the ax-sense that will notify you through Threema when your physical mailbox just changed from empty to full, or vice versa.

Screenshot

The data can also be logged to an InfluxDB instance so that it can be visualized with Grafana.

Configuration

Export the following environment variables:

  • TTN_APP_ID: The Things Network App ID
  • TTN_ACCESS_KEY: The Things Network Access Key
  • THREEMA_FROM: Your Threema Gateway ID, 8 characters starting with *
  • THREEMA_TO: A comma separated list of recipient Threema IDs
  • THREEMA_SECRET: The Threema Gateway API secret
  • THREEMA_PRIVATE_KEY: The hex encoded private key of your Gateway ID

If you want to send data to InfluxDB too, set the following three env vars:

  • INFLUXDB_USER: The InfluxDB username
  • INFLUXDB_PASS: The InfluxDB password
  • INFLUXDB_DB: The InfluxDB database
  • INFLUXDB_URL: The InfluxDB URL (no trailing slash)

If you don't want to manually export environment variables, you can also write them into a .env file (format: KEY=value, one entry per line).

Building

Type make to see possible build targets.

There are options to build a release binary on your local machine, or in a Debian 8 Docker container.

Deployment

An example smartmail.service file for systemd based Linux distributions is provided.

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

About

Smart mailbox powered by LoRaWAN, TTN, ax-sense and Threema.

Resources

License

Apache-2.0, MIT licenses found

Licenses found

Apache-2.0
LICENSE-APACHE
MIT
LICENSE-MIT

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published