Rename from teleinfo-mqtt to teleinfo2mqtt

lyra-mmartin · lyra-mmartin · commit 6e6f922d6d59 · 2022-06-13T19:05:08.000+02:00
diff --git a/.travis.yml b/.travis.yml
@@ -56,4 +56,4 @@ after_success:
   - docker login -u "$DOCKER_USERNAME" -p "$DOCKER_PASSWORD"
   - docker version
   - make prepare
-  - make build IMAGE_NAME=$DOCKER_USERNAME/teleinfo-mqtt IMAGE_VERSION=$IMAGE_VERSION PLATFORMS=linux/arm/v6,linux/arm/v7,linux/arm64/v8,linux/amd64
+  - make build IMAGE_NAME=$DOCKER_USERNAME/teleinfo2mqtt IMAGE_VERSION=$IMAGE_VERSION PLATFORMS=linux/arm/v6,linux/arm/v7,linux/arm64/v8,linux/amd64
diff --git a/README.md b/README.md
@@ -1,23 +1,27 @@
-# teleinfo-mqtt
+# teleinfo2mqtt
 
-![Docker pulls](https://img.shields.io/docker/pulls/fmartinou/teleinfo-mqtt)
-![License](https://img.shields.io/github/license/fmartinou/teleinfo-mqtt)
-![Travis](https://img.shields.io/travis/fmartinou/teleinfo-mqtt/master)
-![Maintainability](https://img.shields.io/codeclimate/maintainability/fmartinou/teleinfo-mqtt)
-![Coverage](https://img.shields.io/codeclimate/coverage/fmartinou/teleinfo-mqtt)
+![Docker pulls](https://img.shields.io/docker/pulls/fmartinou/teleinfo2mqtt)
+![License](https://img.shields.io/github/license/fmartinou/teleinfo2mqtt)
+![Travis](https://img.shields.io/travis/fmartinou/teleinfo2mqtt/master)
+![Maintainability](https://img.shields.io/codeclimate/maintainability/fmartinou/teleinfo2mqtt)
+![Coverage](https://img.shields.io/codeclimate/coverage/fmartinou/teleinfo2mqtt)
 
-![](docs/teleinfo-mqtt-logo-250.png)
+![](docs/teleinfo2mqtt-logo-250.png)
 
-**Teleinfo-Mqtt** allows you to read Teleinfo frames from a Serial port and publish them to an Mqtt broker.
+### Serial-to-MQTT Teleinfo Bridge
+
+**teleinfo2mqtt** allows you to read Teleinfo frames from a Serial port and publish them to an Mqtt broker.
 
 ## Ready to go?
-### Check out the [documentation](https://fmartinou.github.io/teleinfo-mqtt/) to get started!
+### Check out the [documentation](https://fmartinou.github.io/teleinfo2mqtt/) to get started!
 
 ## Contact & Support
 
-- Create a [GitHub issue](https://github.com/fmartinou/teleinfo-mqtt/issues) for bug reports, feature requests, or questions
-- Add a ⭐️ [star on GitHub](https://github.com/fmartinou/teleinfo-mqtt) to support the project!
+- Create a [GitHub issue](https://github.com/fmartinou/teleinfo2mqtt/issues) for bug reports, feature requests, or questions
+- Add a ⭐️ [star on GitHub](https://github.com/fmartinou/teleinfo2mqtt) to support the project!
+
+<a href="https://www.buymeacoffee.com/61rUNMm" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png" alt="Buy Me A Coffee" style="height: 41px !important;width: 174px !important;box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;-webkit-box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;" ></a>
 
 ## License
 
-This project is licensed under the [MIT license](https://github.com/fmartinou/teleinfo-mqtt/blob/master/LICENSE).
+This project is licensed under the [MIT license](https://github.com/fmartinou/teleinfo2mqtt/blob/master/LICENSE).
diff --git a/app/index.js b/app/index.js
@@ -9,7 +9,7 @@ const log = require('./log');
  */
 async function run() {
     const configHidden = { ...config, mqttPassword: '<hidden>' };
-    log.info('Starting teleinfo-mqtt with configuration =', configHidden);
+    log.info('Starting teleinfo2mqtt with configuration =', configHidden);
 
     try {
         // Connect to the serial port
diff --git a/app/log/index.js b/app/log/index.js
@@ -2,7 +2,7 @@ const bunyan = require('bunyan');
 const config = require('../config');
 
 const log = bunyan.createLogger({
-    name: 'teleinfo-mqtt',
+    name: 'teleinfo2mqtt',
     level: config.logLevel,
 });
 
diff --git a/app/package-lock.json b/app/package-lock.json
diff --git a/app/package.json b/app/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "teleinfo-mqtt-app",
+  "name": "teleinfo2mqtt-app",
   "version": "1.0.0",
   "description": "Publish teleinfo to mqtt topics",
   "main": "index.js",
@@ -10,7 +10,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/fmartinou/teleinfo-mqtt.git"
+    "url": "git+https://github.com/fmartinou/teleinfo2mqtt.git"
   },
   "keywords": [
     "teleinfo",
@@ -19,9 +19,9 @@
   "author": "fmartinou",
   "license": "ISC",
   "bugs": {
-    "url": "https://github.com/fmartinou/teleinfo-mqtt/issues"
+    "url": "https://github.com/fmartinou/teleinfo2mqtt/issues"
   },
-  "homepage": "https://github.com/fmartinou/teleinfo-mqtt#readme",
+  "homepage": "https://github.com/fmartinou/teleinfo2mqtt#readme",
   "dependencies": {
     "@serialport/parser-readline": "9.2.4",
     "async-mqtt": "2.6.2",
diff --git a/docs/_coverpage.md b/docs/_coverpage.md
@@ -1,6 +1,6 @@
-![logo](teleinfo-mqtt-logo.png)
+![logo](teleinfo2mqtt-logo.png)
 
-# **Teleinfo Mqtt**
+# **teleinfo2Mqtt**
 
 > Serial-to-MQTT Teleinfo Bridge
 
diff --git a/docs/changelog/README.md b/docs/changelog/README.md
@@ -8,7 +8,7 @@
 - :fire: Fix `STANDARD` frames bad parsing 
 
 ## 7.0.0
-- :star: Add support for TIC `STANDARD` mode (:warning:**EXPERIMENTAL!!!**:warning:)
+- :star: Add support for TIC `STANDARD` mode
 
 ## 6.1.0
 - :star: Add compatibility to [Home-Assistant add-on system](https://github.com/fmartinou/hassio-addons) 
diff --git a/docs/configuration/README.md b/docs/configuration/README.md
@@ -1,22 +1,22 @@
 # Configuration
-Teleinfo-Mqtt can be configured using Environment Variables.
+**teleinfo2mqtt** can be configured using Environment Variables.
 
 ## Environment variables
 
-| Env var               | Required       | Description                                                            | Supported values                                                                 | Default value when missing |
-|-----------------------|----------------|------------------------------------------------------------------------|----------------------------------------------------------------------------------|----------------------------|
-| EMIT_INTERVAL         | :white_circle: | Interval in seconds between 2 MQTT emissions (0 = All frames are sent) | from `0` to `n`                                                                  | `10`                       |
-| HASS_DISCOVERY        | :white_circle: | Publish configuration for Home-Assistant discovery                     | `true`, `false`                                                                  | `true`                     |
-| HASS_DISCOVERY_PREFIX | :white_circle: | Topic prefix for Home-Assistant Discovery                              | any                                                                              | `homeassistant`            |
-| LOG_LEVEL             | :white_circle: | Log level                                                              | `error`, `info`, `debug`                                                         | `info`                     |
-| LOG_FORMAT            | :white_circle: | Log format                                                             | `text`, `json`                                                                   | `text`                     |
-| MQTT_BASE_TOPIC       | :white_circle: | MQTT Base topic                                                        | any                                                                              | `teleinfo`                 |
-| MQTT_URL              | :white_circle: | MQTT Broker connection URL                                             | any valid mqtt connection string                                                 | `mqtt://localhost:1883`    |
-| MQTT_USER             | :white_circle: | MQTT user     (optional)                                               | any                                                                              |                            |
-| MQTT_PASSWORD         | :white_circle: | MQTT password (optional)                                               | any                                                                              |                            |
-| SERIAL                | :white_circle: | Serial Port location                                                   | any valid serial port location                                                   | `/dev/ttyUSB0`             |
-| TIC_MODE              | :white_circle: | TIC Mode                                                               | `history`, `standard`                                                            | `history`                  |
-| TZ                    | :white_circle: | Timezone (for logs...)                                                 | [supported values](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) | `utc`                      |
+| Env var                   | Required       | Description                                                            | Supported values                                                                 | Default value when missing |
+|---------------------------|----------------|------------------------------------------------------------------------|----------------------------------------------------------------------------------|----------------------------|
+| **EMIT_INTERVAL**         | :white_circle: | Interval in seconds between 2 MQTT emissions (0 = All frames are sent) | from `0` to `n`                                                                  | `10`                       |
+| **HASS_DISCOVERY**        | :white_circle: | Publish configuration for Home-Assistant discovery                     | `true`, `false`                                                                  | `true`                     |
+| **HASS_DISCOVERY_PREFIX** | :white_circle: | Topic prefix for Home-Assistant Discovery                              | any                                                                              | `homeassistant`            |
+| **LOG_LEVEL**             | :white_circle: | Log level                                                              | `error`, `info`, `debug`                                                         | `info`                     |
+| **LOG_FORMAT**            | :white_circle: | Log format                                                             | `text`, `json`                                                                   | `text`                     |
+| **MQTT_BASE_TOPIC**       | :white_circle: | MQTT Base topic                                                        | any                                                                              | `teleinfo`                 |
+| **MQTT_URL**              | :white_circle: | MQTT Broker connection URL                                             | any valid mqtt connection string                                                 | `mqtt://localhost:1883`    |
+| **MQTT_USER**             | :white_circle: | MQTT user     (optional)                                               | any                                                                              |                            |
+| **MQTT_PASSWORD**         | :white_circle: | MQTT password (optional)                                               | any                                                                              |                            |
+| **SERIAL**                | :white_circle: | Serial Port location                                                   | any valid serial port location                                                   | `/dev/ttyUSB0`             |
+| **TIC_MODE**              | :white_circle: | TIC Mode                                                               | `history`, `standard`                                                            | `history`                  |
+| **TZ**                    | :white_circle: | Timezone (for logs...)                                                 | [supported values](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) | `utc`                      |
 
 ## Complete example
 
@@ -27,7 +27,7 @@ version: '3'
 
 services:
   teleinfo2mqtt:
-    image: fmartinou/teleinfo-mqtt
+    image: fmartinou/teleinfo2mqtt
     container_name: teleinfo2mqtt
     device:
       - /dev/ttyUSB1:/dev/ttyUSB1
@@ -49,6 +49,6 @@ docker run -d --name teleinfo2mqtt \
   -e MQTT_USER="my-super-user" \
   -e MQTT_PASSWORD="my-secret-password" \
   -e TZ="Europe/Paris" \
-  fmartinou/teleinfo-mqtt
+  fmartinou/teleinfo2mqtt
 ```
 <!-- tabs:end -->
diff --git a/docs/hass/README.md b/docs/hass/README.md
@@ -2,10 +2,10 @@
 
 ![logo](hass.png)
 
-`teleinfo-mqtt` can be integrated to [Home-Assistant](https://www.home-assistant.io/) in 2 distinct ways.
+**teleinfo2mqtt** can be integrated to [Home-Assistant](https://www.home-assistant.io/) in 2 distinct ways.
 
 > **Solution 1:** \
-Deploy the `teleinfo-mqtt` docker image by yourself ([see here](/introduction/))
+Deploy the `teleinfo2mqtt` docker image by yourself ([see here](/introduction/))
 
 > **Solution 2:** \
 Install the [`teleinfo2mqtt` hass.io add-on](https://github.com/fmartinou/hassio-addons)
diff --git a/docs/index.html b/docs/index.html
@@ -4,7 +4,7 @@
   <meta charset="UTF-8">
   <title>Teleinfo Mqtt</title>
   <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
-  <meta name="description" content="Teleinfo Mqtt">
+  <meta name="description" content="teleinfo2mqtt">
   <meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
 
   <!-- Default theme -->
@@ -13,17 +13,17 @@
   <!-- Prism theme (code highlighting -->
   <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism.css">
 
-  <!-- Teleinfo-mqtt theme -->
-  <link rel="stylesheet" href="/theme-teleinfo-mqtt.css">
+  <!-- teleinfo2mqtt theme -->
+  <link rel="stylesheet" href="/teleinfo2mqtt.css">
 
 </head>
 <body>
   <div id="app">Please wait...</div>
   <script>
     window.$docsify = {
-      name: 'teleinfo-mqtt',
-      logo: '/teleinfo-mqtt-logo.png',
-      repo: 'fmartinou/teleinfo-mqtt',
+      name: 'teleinfo2mqtt',
+      logo: '/teleinfo2mqtt-logo.png',
+      repo: 'fmartinou/teleinfo2mqtt',
       coverpage: true,
       onlyCover: true,
       loadSidebar: 'sidebar.md',
diff --git a/docs/introduction/README.md b/docs/introduction/README.md
@@ -1,17 +1,19 @@
 # Introduction
 
-![Docker pulls](https://img.shields.io/docker/pulls/fmartinou/teleinfo-mqtt)
-![License](https://img.shields.io/github/license/fmartinou/teleinfo-mqtt)
-![Travis](https://img.shields.io/travis/fmartinou/teleinfo-mqtt/master)
-![Maintainability](https://img.shields.io/codeclimate/maintainability/fmartinou/teleinfo-mqtt)
-![Coverage](https://img.shields.io/codeclimate/coverage/fmartinou/teleinfo-mqtt)
+![Docker pulls](https://img.shields.io/docker/pulls/fmartinou/teleinfo2mqtt)
+![License](https://img.shields.io/github/license/fmartinou/teleinfo2mqtt)
+![Travis](https://img.shields.io/travis/fmartinou/teleinfo2mqtt/master)
+![Maintainability](https://img.shields.io/codeclimate/maintainability/fmartinou/teleinfo2mqtt)
+![Coverage](https://img.shields.io/codeclimate/coverage/fmartinou/teleinfo2mqtt)
 
-**Teleinfo-Mqtt** allows you to read Teleinfo frames from a Serial port and publish them to an Mqtt broker.
+**teleinfo2mqtt** allows you to read Teleinfo frames from a Serial port and publish them to an Mqtt broker.
+
+> **teleinfo2mqtt** supports both `HISTORY` and `̀STANDARD` modes.
 
 ## Quick start
 
 ### Run the Docker image
-The easiest way to start is to deploy the official _**teleinfo-mqtt**_ image.
+The easiest way to start is to deploy the official _**teleinfo2mqtt**_ image.
 
 <!-- tabs:start -->
 #### **Docker Compose**
@@ -20,7 +22,7 @@ version: '3'
 
 services:
   teleinfo2mqtt:
-    image: fmartinou/teleinfo-mqtt
+    image: fmartinou/teleinfo2mqtt
     container_name: teleinfo2mqtt
     device:
       - /dev/ttyUSB0:/dev/ttyUSB0             # Serial port device
@@ -32,18 +34,18 @@ services:
 docker run -d --name teleinfo2mqtt \
   --device=/dev/ttyUSB0:/dev/ttyUSB0 \
   -e MQTT_URL=mqtt://my_mqtt_broker:1883 \
-  fmartinou/teleinfo-mqtt
+  fmartinou/teleinfo2mqtt
 ```
 <!-- tabs:end -->
 
 ## Contact & Support
 
-- Create a [GitHub issue](https://github.com/fmartinou/teleinfo-mqtt/issues) for bug reports, feature requests, or questions
-- Add a ⭐️ [star on GitHub](https://github.com/fmartinou/teleinfo-mqtt) to support the project!
+- Create a [GitHub issue](https://github.com/fmartinou/teleinfo2mqtt/issues) for bug reports, feature requests, or questions
+- Add a ⭐️ [star on GitHub](https://github.com/fmartinou/teleinfo2mqtt) to support the project!
 
 ## License
 
-This project is licensed under the [MIT license](https://github.com/fmartinou/teleinfo-mqtt/blob/master/LICENSE).
+This project is licensed under the [MIT license](https://github.com/fmartinou/teleinfo2mqtt/blob/master/LICENSE).
 
 <!-- GitHub Buttons -->
 <script async defer src="https://buttons.github.io/buttons.js"></script>
diff --git a/docs/mqtt/README.md b/docs/mqtt/README.md
@@ -1,19 +1,24 @@
 # Mqtt
 
 ## Topic
-Messages are published to a `$MQTT_BASE_TOPIC/$ADCO` topic.
+**teleinfo2mqtt** publishes messages to the `$mqtt_base_topicMQTT_BASE_TOPIC/c` topic.
 
 ?> [`$MQTT_BASE_TOPIC`](configuration/) is configured by env var (`teleinfo` by default)
 
-?> `$ADCO` is the id of your electricity meter (received from teleinfo data)
+?> `$mqtt_base_topic` is the id of your electricity meter (received from teleinfo data as `ADCO` or `ADSC` labels)
 
 ## Message
 Messages are JSON documents whose content may vary upon your Electricity meter.
 
 ?> Values are sanitized and converted to Numbers if possible.  
 You can still access the original `raw` value if necessary.
 
-### Example
+?> When timestamps are part of the value, they are parsed to UTC timestamps and daylight saving time information.
+
+### Data example
+
+<!-- tabs:start -->
+#### **History mode**
 ```json
 {
     "ADCO": {
@@ -59,3 +64,29 @@ You can still access the original `raw` value if necessary.
 }
 ```
 
+#### **Standard mode**
+```json
+{
+  "ADSC": {
+    "raw": "12345678901",
+    "value": 12345678901
+  },
+  "EASF06":{
+    "raw":"000000000",
+    "value":0
+  },
+  "NGTF":{
+    "raw":"H PLEINE/CREUSE",
+    "value":"H PLEINE/CREUSE"
+  },
+  "SMAXSN":{
+    "raw":"02740",
+    "value":2740,
+    "timestamp":{
+      "date":"2022-06-09T06:05:31.000Z",
+      "dst":"summer"
+    }
+  }
+}
+```
+<!-- tabs:end -->
diff --git a/docs/package-lock.json b/docs/package-lock.json
diff --git a/docs/package.json b/docs/package.json
@@ -1,13 +1,13 @@
 {
-  "name": "teleinfo-mqtt-doc",
+  "name": "teleinfo2mqtt-doc",
   "version": "1.0.0",
   "description": "Teleinfo Mqtt doc",
   "main": "index.js",
   "scripts": {
     "doc": "docsify serve"
   },
   "author": "fmartinou",
-  "repository": "fmartinou/teleinfo-mqtt",
+  "repository": "fmartinou/teleinfo2mqtt",
   "license": "MIT",
   "devDependencies": {
     "docsify-cli": "4.4.3"
diff --git a/docs/teleinfo-mqtt.css b/docs/teleinfo-mqtt.css
diff --git a/docs/teleinfo2mqtt-logo-250.png b/docs/teleinfo2mqtt-logo-250.png
diff --git a/docs/teleinfo2mqtt-logo.png b/docs/teleinfo2mqtt-logo.png
diff --git a/docs/teleinfo2mqtt.css b/docs/teleinfo2mqtt.css
@@ -0,0 +1,5 @@
+:root {
+    --base-font-size    : 14px;
+    --theme-color       : #00355E;
+    --content-max-width : 100em;
+}
