https://github.com/dbrgn/smartmail

Smart mailbox powered by LoRaWAN, TTN, ax-sense and Threema.
https://github.com/dbrgn/smartmail

Last synced: 3 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/dbrgn/smartmail
• Owner: dbrgn
• License: apache-2.0
• Created: 2017-09-23T23:23:46.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2018-04-11T16:37:20.000Z (about 8 years ago)
• Last Synced: 2026-01-11T12:59:51.183Z (6 months ago)
• Language: Rust
• Homepage:
• Size: 91.8 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE-APACHE

Awesome Lists containing this project

README

          
# smartmail

[![CircleCI][circle-ci-badge]][circle-ci]

This is a "smart mailbox" based on LoRaWAN and the

[ax-sense](https://twitter.com/adnexo_gmbh/status/901370927405047808) that will

notify you through [Threema](https://threema.ch/) when your physical mailbox

just changed from empty to full, or vice versa.

![Screenshot](screenshot.jpg)

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

 * Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)

 * MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)

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.

[circle-ci]: https://circleci.com/gh/dbrgn/smartmail/tree/master

[circle-ci-badge]: https://circleci.com/gh/dbrgn/smartmail/tree/master.svg?style=shield