Setup CI/CD

.github/workflows/run.yml

@@ -0,0 +1,67 @@
+name: CI/CD
+
+on:
+  - push
+  - pull_request
+  - workflow_dispatch
+
+jobs:
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 18
+      - run: npm ci
+      - run: npm run lint
+
+  test:
+    name: Test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 18
+      - run: npm ci
+      - run: npm run build
+
+  build:
+    name: Build Docker image
+    runs-on: ubuntu-latest
+    if: ${{ !startsWith(github.ref, 'refs/tags/') }}
+    needs:
+      - lint
+      - test
+    steps:
+      - uses: actions/checkout@v3
+      - uses: home-assistant/builder@master
+        with:
+          args: |
+            --test \
+            --all \
+            --target . \
+            --docker-hub ghcr.io/bokub
+
+  publish:
+    name: Build and publish Docker image
+    runs-on: ubuntu-latest
+    if: startsWith(github.ref, 'refs/tags/') # Invert
+    needs:
+      - lint
+      - test
+    steps:
+      - uses: actions/checkout@v3
+      - uses: docker/login-action@v2
+        with:
+          registry: ghcr.io
+          username: bokub
+          password: ${{ secrets.CR_PAT }}
+      - uses: home-assistant/builder@master
+        with:
+          args: |
+            --all \
+            --target . \
+            --docker-hub ghcr.io/bokub

CONTRIBUTING.md

@@ -15,5 +15,5 @@
 docker run --rm --privileged \
 	-v ~/.docker:/root/.docker \
 	-v ./:/data \
-	homeassistant/amd64-builder --all -t /data
+	homeassistant/amd64-builder --all -t /data --test --docker-hub ghcr.io/bokub
 ```

Dockerfile

@@ -1,16 +1,18 @@
 ARG BUILD_FROM
 FROM $BUILD_FROM
 
-RUN \
-  apk add --no-cache \
-    nodejs npm
+LABEL org.opencontainers.image.source=https://github.com/bokub/ha-linky
+LABEL org.opencontainers.image.description="HA Linky Add-on"
+LABEL org.opencontainers.image.licenses=MIT
+
+RUN apk add --no-cache nodejs npm
 
 WORKDIR /linky
 
 # Install dependencies
 COPY package.json .
 COPY package-lock.json .
-RUN npm install
+RUN npm ci --ignore-scripts
 
 # Copy add-on code
 COPY . .

README.md

@@ -1,3 +1,3 @@
-# HA Linky
+# Home Assistant Linky Add-on
 
 > A **Home Assistant** add-on to sync Energy dashboards with your **Linky** smart meter

config.yaml

@@ -1,6 +1,6 @@
 name: 'Linky'
-description: 'TODO'
-version: '1.0.0'
+description: 'Home Assistant add-on to sync Energy dashboards with Linky smart meters'
+version: '0.1.0'
 slug: 'linky'
 init: false
 url: 'https://github.com/bokub/ha-linky'

package.json

@@ -1,13 +1,14 @@
 {
   "name": "ha-linky",
   "private": true,
-  "version": "1.0.0",
-  "description": "Home Assistant add-on for Linky smart meters",
+  "version": "0.1.0",
+  "description": "Home Assistant add-on to sync Energy dashboards with Linky smart meters",
   "author": "First Last <[email protected]>",
   "type": "module",
   "scripts": {
     "build": "tsc",
-    "prepare": "husky install"
+    "prepare": "husky install",
+    "lint": "npx prettier --check --ignore-path .gitignore ."
   },
   "prettier": "@bokub/prettier-config",
   "dependencies": {

src/ha.ts

@@ -95,7 +95,7 @@ export class HomeAssistantClient {
       metadata: {
         has_mean: false,
         has_sum: true,
-        name: 'Consommation Linky ' + prm,
+        name: `Linky ${prm}`, // TODO make it configurable
         source: SOURCE,
         statistic_id: statisticId,
         unit_of_measurement: 'Wh',
@@ -122,7 +122,7 @@ export class HomeAssistantClient {
   }> {
     const isNew = await this.isNewPRM(prm);
     if (isNew) {
-      debug(`No statistics found for PRM ${prm} in Home Assistant`);
+      warn(`PRM ${prm} not found in Home Assistant statistics`);
       return null;
     }
 

src/index.ts

@@ -32,8 +32,8 @@ async function main() {
 
   async function init() {
     info(`New PRM detected, importing as much historical data as possible`);
-    const historicalData = await consumptionClient.getEnergyData(null);
-    await haClient.saveStatistics(userConfig.consumption.prm, historicalData);
+    const energyData = await consumptionClient.getEnergyData(null);
+    await haClient.saveStatistics(userConfig.consumption.prm, energyData);
   }
   async function sync() {
     debug('Data synchronization started');
@@ -50,9 +50,9 @@ async function main() {
       return;
     }
     const firstDay = dayjs(lastStatistic.start).add(1, 'day');
-    const historicalData = await consumptionClient.getEnergyData(firstDay);
-    incrementSums(historicalData, lastStatistic.sum);
-    await haClient.saveStatistics(userConfig.consumption.prm, historicalData);
+    const energyData = await consumptionClient.getEnergyData(firstDay);
+    incrementSums(energyData, lastStatistic.sum);
+    await haClient.saveStatistics(userConfig.consumption.prm, energyData);
   }
 
   const isNew = await haClient.isNewPRM(userConfig.consumption.prm);
@@ -73,7 +73,9 @@ async function main() {
   );
 
   cron.schedule(`${randomSecond} ${randomMinute} 6,9 * * *`, async () => {
+    await haClient.connect();
     await sync();
+    haClient.disconnect();
   });
 }
 

src/linky.ts

@@ -11,7 +11,7 @@ export class LinkyClient {
   constructor(token: string, prm: string) {
     this.prm = prm;
     this.session = new Session(token, prm);
-    this.session.userAgent = 'ha-linky/1.0.0';
+    this.session.userAgent = 'ha-linky/0.1.0';
   }
 
   public async getEnergyData(firstDay: null | Dayjs): Promise<EnergyDataPoint[]> {