coko7 / somfy-home-controller

Simple Node app to automatically control your Somfy shutters based on your local day cycle.

🏠 somfy-home-controller

Simple Node app to automatically control your Somfy shutters based on your local day cycle.

🧰 Requirements

Make sure you have Node.js v16.18.0 installed. This project uses Import Assertions and when I tested with Node v16.14.0 it did not work, so I had to upgrade to v16.18.0.

I am not a Node expert so maybe there is a cleaner way to handle JSON file import within an ES6 module but this is working for now.

🛠️ Setup

1. Clone the repository and open it cd somfy-home-controller
2. Add a new file shc-config.json at the project root:

{
  "somfyUrl": "ha101-1.overkiz.com",
  "pod": "XXXX-XXXX-XXXX",
  "port": 8443,
  "gatewaySuffix": "home",
  "token": "PUT_YOUR_SUPER_SECRET_TOKEN_HERE",
  "location": {
    "latitude": 0.0,
    "longitude": 0.0,
    "altitude": 0,
    "timezone": "Europe/Paris"
  },
  "devices": [
    {
      "protocol": "io",
      "id": "shutter_kitchen",
      "name": "Volet Cuisine",
      "url": "io://XXXX-XXXX-XXXX//1111111"
    },
    {
      "protocol": "io",
      "id": "shutter_kitchen_door",
      "name": "Volet Porte Cuisine",
      "url": "io://XXXX-XXXX-XXXX//2222222"
    },
    {
      "protocol": "io",
      "id": "shutter_room",
      "name": "Volet Chambre",
      "url": "io://XXXX-XXXX-XXXX/3333333"
    }
  ]
}

3. Set the pod and token to link to your local Tahoma API

4. Fill in the location data with (altitude and timezone are optional). But timezone is not supported yet anyway...

5. Setup the devices you want to control automatically. Only shutters are supported.

6. Once your config file is all set, you can test the script with npm start. But if you want to have this script running all day, you might want to use actual libraries such as pm2 or forever. In case you are using pm2, you can start the script in background like this:

   pm2 start npm --name "my-somfy-home-controller" -- start 

💻 Command Line Interface

It is also possible to use a CLI to manually interact with the Tahoma box. To launch the CLI, simply enter npm run cli in your shell. Here is what the latest version of the CLI looks like:

If you want full control over a device, you should control it via the device mode.

You can enter device mode by typing load <id> in the general CLI. The <id> refers to the combination of digits after the gateway pin in the device URL.

📚 Resources

• GitHub repo of Somfy-TaHoma-Developer-Mode
• Swagger UI for local gateway API
• Get yearly daylight cycles on: https://dev.timeanddate.com/time/

somfy-home-controller's Issues

Use sunrise equation instead of precomputed time data (CSV)

It might be worth looking into what calculations are needed to find the exact time of sunrise/sunset at a specific location on Earth.
One place to start looking: https://en.wikipedia.org/wiki/Sunrise_equation

Add tests to make sure API works

Write new tests to ensure that the API can be queried successfully

Install Winston logger for better logging capabilities

Add more logs

It would be useful to have the following logs:

• When the script starts for the first time, log the time of the next event (open shutters if before sunrise, close shutters if before sunset)
• After each event, log the time of the next event (time of open / close)

Add unit tests

Add unit tests for testing whether certain actions are executed at the right time of the day.
External lib such as Jest can be used.

Option to turn off automatic opening/closing per day

Add a parameter in config.json to allow the user to specify certain days when automatic opening/closing should be disabled

Use .env file instead of json file for config

This will remove the need of using Import assertions.

Move hardcoded values to config

Extract most of the hardcoded values from sun-tracker.js into shc-config.json

Use suncalc npm package to get sunrise/sunset

Thanks to ChatGPT, it appears that there was already a package for getting sun positions based on latitude, longitude and timestamp all along!

It is the suncalc package by mourner: https://www.npmjs.com/package/suncalc

Very easy to use and good enough documentation too.

The next step is to replace the current implementation to use this package instead of reading sun positions from a prefetched CSV file. The times are relatively the same as the ones in the CSV, but they should be even more accurate as you can provide the exact latitude, longitude and altitude as well.