doc: added README.md and LICENSE file

LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2020 Vincent Composieux <github@composieux.fr>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,118 @@
+# Tado° Prometheus Exporter
+
+[![TravisBuildStatus](https://api.travis-ci.org/eko/tado-exporter.svg?branch=master)](https://travis-ci.org/eko/tado-exporter)
+
+This is a Prometheus exporter for [tado°](https://www.tado.com/) thermostatic handles.
+
+## Prerequisites
+
+In case you want to develop on this project, you will need:
+
+* [Rust](https://www.rust-lang.org/)
+
+If you just want to use it, you need nothing apart download and run the binary file in the next step.
+
+## Installation
+
+### Download binary
+
+You can download the latest version of the binary built for your architecture here:
+
+* Architecture **x86_64** [
+    [Linux](https://github.com/eko/tado-exporter/releases/latest/download/tado-exporter-v0.0.3-x86_64-unknown-linux-gnu.tar.gz)
+]
+* Architecture **arm** [
+    [Linux](https://github.com/eko/tado-exporter/releases/latest/download/tado-exporter-v0.0.3-arm-unknown-linux-gnueabihf.tar.gz)
+]
+
+### From sources
+
+Optionally, you can download and build it from the sources. You have to retrieve the project sources by using one of the following way:
+```bash
+$ git clone https://github.com/eko/tado-exporter
+```
+
+Then, just build the binary:
+
+```
+$ cargo build --release
+```
+
+## Usage
+
+In order to run the exporter, type the following command (arguments are optional):
+
+```bash
+$ export EXPORTER_TICKER=10
+$ export EXPORTER_USERNAME="my-username@acme.tld"
+$ export EXPORTER_PASSWORD="your-password"
+$ ./tado-exporter
+--- tado° exporter configuration ---
+Ticker seconds: 10
+Username: my-username@acme.tld
+Password: your-password
+Client secret: wZaRN7rpjn3FoNyF5IFuxg9uMzYJcvOoQ8QWiIqS3hfk6gLhVlG57j5YNoZL2Rtc
+------------------------------------
+[2020-02-29T08:56:19Z INFO  tado_exporter] starting tado° exporter on address: V4(0.0.0.0:9898)
+[2020-02-29T08:56:19Z INFO  tado_exporter] waiting for the first tick in 10 seconds...
+[2020-02-29T08:56:30Z INFO  tado_exporter::tado::client] retrieving zone details for Office...
+[2020-02-29T08:56:30Z INFO  tado_exporter::tado::client] retrieving zone details for Kitchen...
+[2020-02-29T08:56:30Z INFO  tado_exporter::tado::client] retrieving zone details for Living Room...
+[2020-02-29T08:56:30Z INFO  tado_exporter::tado::client] retrieving zone details for Room...
+[2020-02-29T08:56:30Z INFO  tado_exporter::tado::metrics] -> Office -> setting temperature (celsius): 23
+[2020-02-29T08:56:30Z INFO  tado_exporter::tado::metrics] -> Office -> setting temperature (fahrenheit): 73.4
+[2020-02-29T08:56:30Z INFO  tado_exporter::tado::metrics] -> Office -> sensor temperature (celsius): 23.75
+[2020-02-29T08:56:30Z INFO  tado_exporter::tado::metrics] -> Office -> sensor temperature (fahrenheit): 74.75
+[2020-02-29T08:56:30Z INFO  tado_exporter::tado::metrics] -> Office -> sensor humidity: 40.1%
+[2020-02-29T08:56:30Z INFO  tado_exporter::tado::metrics] -> Office -> heating power: 38%
+[2020-02-29T08:56:30Z INFO  tado_exporter::tado::metrics] -> Kitchen -> setting temperature (celsius): 22
+[2020-02-29T08:56:30Z INFO  tado_exporter::tado::metrics] -> Kitchen -> setting temperature (fahrenheit): 71.6
+[2020-02-29T08:56:30Z INFO  tado_exporter::tado::metrics] -> Kitchen -> sensor temperature (celsius): 22.03
+[2020-02-29T08:56:30Z INFO  tado_exporter::tado::metrics] -> Kitchen -> sensor temperature (fahrenheit): 71.65
+[2020-02-29T08:56:30Z INFO  tado_exporter::tado::metrics] -> Kitchen -> sensor humidity: 42.7%
+[2020-02-29T08:56:30Z INFO  tado_exporter::tado::metrics] -> Kitchen -> heating power: 0%
+[2020-02-29T08:56:30Z INFO  tado_exporter::tado::metrics] -> Living Room -> setting temperature (celsius): 22
+[2020-02-29T08:56:30Z INFO  tado_exporter::tado::metrics] -> Living Room -> setting temperature (fahrenheit): 71.6
+[2020-02-29T08:56:30Z INFO  tado_exporter::tado::metrics] -> Living Room -> sensor temperature (celsius): 22.49
+[2020-02-29T08:56:30Z INFO  tado_exporter::tado::metrics] -> Living Room -> sensor temperature (fahrenheit): 72.48
+[2020-02-29T08:56:30Z INFO  tado_exporter::tado::metrics] -> Living Room -> sensor humidity: 42.2%
+[2020-02-29T08:56:30Z INFO  tado_exporter::tado::metrics] -> Living Room -> heating power: 0%
+[2020-02-29T08:56:30Z INFO  tado_exporter::tado::metrics] -> Room -> setting temperature (celsius): 20
+[2020-02-29T08:56:30Z INFO  tado_exporter::tado::metrics] -> Room -> setting temperature (fahrenheit): 68
+[2020-02-29T08:56:30Z INFO  tado_exporter::tado::metrics] -> Room -> sensor temperature (celsius): 21.42
+[2020-02-29T08:56:30Z INFO  tado_exporter::tado::metrics] -> Room -> sensor temperature (fahrenheit): 70.56
+[2020-02-29T08:56:30Z INFO  tado_exporter::tado::metrics] -> Room -> sensor humidity: 45.8%
+[2020-02-29T08:56:30Z INFO  tado_exporter::tado::metrics] -> Room -> heating power: 0%
+...
+```
+
+Once the exporter is running, you also have to update your `prometheus.yml` configuration to let it scrape the exporter:
+
+```yaml
+scrape_configs:
+  - job_name: 'tado'
+    static_configs:
+      - targets: ['localhost:9898']
+```
+
+## Available environment variables
+
+| Environment variable name    | Description                                                                                |
+|:----------------------------:|--------------------------------------------------------------------------------------------|
+| EXPORTER_USERNAME      | Required. This represent your tado° account username/email                                       |
+| EXPORTER_PASSWORD      | Required. This represent your tado° account password                                             |
+| EXPORTER_CLIENT_SECRET | Optional. This represent your tado° account client secret, using default value seems to work     |
+| EXPORTER_TICKER        | Optional (default: 10). This represent the number of seconds the exporter will look for new data |
+
+## Available Prometheus metrics
+
+| Metric name                  | Description                                                                                |
+|:----------------------------:|--------------------------------------------------------------------------------------------|
+| tado_activity_heating_power_percentage | This represent the % of heating power for every zone                             |
+| tado_setting_temperature_value         | This represent the current temperature you asked/programmed in a zone            |
+| tado_sensor_temperature_value          | This represent the current temperature detected by sensor in a zone              |
+| tado_sensor_humidity_percentage        | This represent the current humidity % detected by sensor in a zone               |
+
+## Community welcome
+
+Please feel free to contribute to this project in order to make it evolve. You're very welcome.

src/main.rs

@@ -52,6 +52,8 @@ fn run_ticker(config: config_loader::Config) {
     tokio::spawn(async move {
         let mut tado_client = TadoClient::new(config.username, config.password, config.client_secret);
 
+        info!("waiting for the first tick in {} seconds...", config.ticker);
+
         let ticker = Ticker::new(0.., Duration::from_secs(config.ticker));
         for _ in ticker {
             metrics::set(