{"id":16546710,"url":"https://github.com/karbassi/netatmo","last_synced_at":"2025-03-16T19:32:38.506Z","repository":{"id":14998402,"uuid":"17723814","full_name":"karbassi/netatmo","owner":"karbassi","description":"A node.js module to hook into the netatmo API.","archived":false,"fork":false,"pushed_at":"2022-12-07T17:39:38.000Z","size":179,"stargazers_count":57,"open_issues_count":21,"forks_count":46,"subscribers_count":14,"default_branch":"main","last_synced_at":"2024-04-14T13:11:40.541Z","etag":null,"topics":["javascript","netatmo","netatmo-api","node","node-module","npm"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/karbassi.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-03-13T19:48:00.000Z","updated_at":"2023-12-28T20:41:41.000Z","dependencies_parsed_at":"2023-01-13T18:13:02.243Z","dependency_job_id":null,"html_url":"https://github.com/karbassi/netatmo","commit_stats":null,"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/karbassi%2Fnetatmo","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/karbassi%2Fnetatmo/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/karbassi%2Fnetatmo/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/karbassi%2Fnetatmo/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/karbassi","download_url":"https://codeload.github.com/karbassi/netatmo/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243826798,"owners_count":20354221,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["javascript","netatmo","netatmo-api","node","node-module","npm"],"created_at":"2024-10-11T19:11:25.664Z","updated_at":"2025-03-16T19:32:38.256Z","avatar_url":"https://github.com/karbassi.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# netatmo [![npm version](https://img.shields.io/npm/v/netatmo.svg?maxAge=2592000)](https://www.npmjs.com/package/netatmo) [![Downloads](https://img.shields.io/npm/dm/netatmo.svg?maxAge=2592000)](https://www.npmjs.com/package/netatmo)\n\nA node.js module to interface with the [netatmo api](http://dev.netatmo.com/) API.\n\n## Getting Starting\n\n1. Make sure you have a netatmo account.\n2. Make sure you have at least one netatmo device set up.\n\n## Install\n\n```sh\nnpm install netatmo\n```\n\n## Example #1\n\n```javascript\nvar netatmo = require('netatmo');\n\nvar auth = {\n  \"client_id\": \"\",\n  \"client_secret\": \"\",\n  \"username\": \"\",\n  \"password\": \"\",\n};\n\nvar api = new netatmo(auth);\n\n// Get Stations Data\n// See docs: https://dev.netatmo.com/dev/resources/technical/reference/weatherstation/getstationsdata\napi.getStationsData(function(err, devices) {\n  console.log(devices);\n});\n\n// Get Measure\n// See docs: https://dev.netatmo.com/dev/resources/technical/reference/common/getmeasure\nvar options = {\n  device_id: '',\n  scale: 'max',\n  type: ['Temperature', 'CO2', 'Humidity', 'Pressure', 'Noise'],\n};\n\napi.getMeasure(options, function(err, measure) {\n  console.log(measure.length);\n  console.log(measure[0]);\n});\n\n\n// Set Sync Schedule\n// See docs: https://dev.netatmo.com/dev/resources/technical/reference/thermostat/syncschedule\nvar options = {\n  device_id: '',\n  module_id: '',\n  zones: [\n    { type: 0, id: 0, temp: 19 },\n    { type: 1, id: 1, temp: 17 },\n    { type: 2, id: 2, temp: 12 },\n    { type: 3, id: 3, temp: 7 },\n    { type: 5, id: 4, temp: 16 }\n  ],\n  timetable: [\n    { m_offset: 0, id: 1 },\n    { m_offset: 420, id: 0 },\n    { m_offset: 480, id: 4 },\n    { m_offset: 1140, id: 0 },\n    { m_offset: 1320, id: 1 },\n    { m_offset: 1860, id: 0 },\n    { m_offset: 1920, id: 4 },\n    { m_offset: 2580, id: 0 },\n    { m_offset: 2760, id: 1 },\n    { m_offset: 3300, id: 0 },\n    { m_offset: 3360, id: 4 },\n    { m_offset: 4020, id: 0 },\n    { m_offset: 4200, id: 1 },\n    { m_offset: 4740, id: 0 },\n    { m_offset: 4800, id: 4 },\n    { m_offset: 5460, id: 0 },\n    { m_offset: 5640, id: 1 },\n    { m_offset: 6180, id: 0 },\n    { m_offset: 6240, id: 4 },\n    { m_offset: 6900, id: 0 },\n    { m_offset: 7080, id: 1 },\n    { m_offset: 7620, id: 0 },\n    { m_offset: 8520, id: 1 },\n    { m_offset: 9060, id: 0 },\n    { m_offset: 9960, id: 1 }\n  ],\n};\n\napi.setSyncSchedule(options, function(err, status) {\n  console.log(status);\n});\n\n\n// Set Thermpoint\n// See docs: https://dev.netatmo.com/dev/resources/technical/reference/thermostat/setthermpoint\nvar options = {\n  device_id: '',\n  module_id: '',\n  setpoint_mode: '',\n};\n\napi.setThermpoint(options, function(err, status) {\n  console.log(status);\n});\n```\n\n## Example #2\n\n```javascript\nvar netatmo = require('netatmo');\n\nvar auth = {\n  \"client_id\": \"\",\n  \"client_secret\": \"\",\n  \"username\": \"\",\n  \"password\": \"\",\n};\n\nvar api = new netatmo(auth);\n\nvar getStationsData = function(err, devices) {\n  console.log(devices);\n};\n\nvar getMeasure = function(err, measure) {\n  console.log(measure.length);\n  console.log(measure[0]);\n};\n\nvar getThermostatsData = function(err, devices) {\n  console.log(devices);\n};\n\nvar setSyncSchedule = function(err, status) {\n  console.log(status);\n};\n\nvar setThermpoint = function(err, status) {\n  console.log(status);\n};\n\nvar getHomeData = function(err, data) {\n  console.log(data);\n};\n\nvar handleEvents = function(err, data) {\n  console.log(data.events_list);\n};\n\n\n// Event Listeners\napi.on('get-stationsdata', getStationsData);\napi.on('get-measure', getMeasure);\napi.on('get-thermostatsdata', getThermostatsData);\napi.on('set-syncschedule', setSyncSchedule);\napi.on('set-thermpoint', setThermpoint);\napi.on('get-homedata', getHomeData);\napi.on('get-nextevents', handleEvents);\napi.on('get-lasteventof', handleEvents);\napi.on('get-eventsuntil', handleEvents);\n\n// Get Stations Data\n// See docs: https://dev.netatmo.com/doc/methods/getstationsdata\napi.getStationsData();\n\n// Get Measure\n// See docs: https://dev.netatmo.com/dev/resources/technical/reference/common/getmeasure\nvar options = {\n  device_id: '',\n  scale: 'max',\n  type: ['Temperature', 'CO2', 'Humidity', 'Pressure', 'Noise'],\n};\n\napi.getMeasure(options);\n\n// Get Thermostats Data\n// See docs: https://dev.netatmo.com/dev/resources/technical/reference/thermostat/getthermostatsdata\nvar options = {\n  device_id: '',\n};\n\napi.getThermostatsData(options);\n\n// Set Sync Schedule\n// See docs: https://dev.netatmo.com/dev/resources/technical/reference/thermostat/syncschedule\nvar options = {\n  device_id: '',\n  module_id: '',\n  zones: [\n    { type: 0, id: 0, temp: 19 },\n    { type: 1, id: 1, temp: 17 },\n    { type: 2, id: 2, temp: 12 },\n    { type: 3, id: 3, temp: 7 },\n    { type: 5, id: 4, temp: 16 }\n  ],\n  timetable: [\n    { m_offset: 0, id: 1 },\n    { m_offset: 420, id: 0 },\n    { m_offset: 480, id: 4 },\n    { m_offset: 1140, id: 0 },\n    { m_offset: 1320, id: 1 },\n    { m_offset: 1860, id: 0 },\n    { m_offset: 1920, id: 4 },\n    { m_offset: 2580, id: 0 },\n    { m_offset: 2760, id: 1 },\n    { m_offset: 3300, id: 0 },\n    { m_offset: 3360, id: 4 },\n    { m_offset: 4020, id: 0 },\n    { m_offset: 4200, id: 1 },\n    { m_offset: 4740, id: 0 },\n    { m_offset: 4800, id: 4 },\n    { m_offset: 5460, id: 0 },\n    { m_offset: 5640, id: 1 },\n    { m_offset: 6180, id: 0 },\n    { m_offset: 6240, id: 4 },\n    { m_offset: 6900, id: 0 },\n    { m_offset: 7080, id: 1 },\n    { m_offset: 7620, id: 0 },\n    { m_offset: 8520, id: 1 },\n    { m_offset: 9060, id: 0 },\n    { m_offset: 9960, id: 1 }\n  ],\n};\n\napi.setSyncSchedule(options);\n\n// Set Thermstate\n// See docs: https://dev.netatmo.com/dev/resources/technical/reference/thermostat/setthermpoint\nvar options = {\n  device_id: '',\n  module_id: '',\n  setpoint_mode: '',\n};\n\napi.setThermpoint(options);\n\n// Get Home Data\n// https://dev.netatmo.com/dev/resources/technical/reference/cameras/gethomedata\napi.getHomeData();\n\n// Get Next Events\n// See docs: https://dev.netatmo.com/dev/resources/technical/reference/cameras/getnextevents\nvar options = {\n  home_id: '',\n  event_id: ''\n};\n\napi.getNextEvents(options);\n\n// Get Last Event Of\n// See docs: https://dev.netatmo.com/dev/resources/technical/reference/cameras/getlasteventof\nvar options = {\n  home_id: '',\n  person_id: ''\n};\n\napi.getLastEventOf(options);\n\n// Get Events Until\n// See docs: https://dev.netatmo.com/dev/resources/technical/reference/cameras/geteventsuntil\nvar options = {\n  home_id: '',\n  event_id: ''\n};\n\napi.getEventsUntil(options);\n\n// Get Camera Picture\n// See docs: https://dev.netatmo.com/dev/resources/technical/reference/cameras/getcamerapicture\nvar options = {\n  image_id: '',\n  key: ''\n};\n\napi.getCameraPicture(options);\n```\n\n## Catching Errors and Warnings\n\n```javascript\nvar netatmo = require('netatmo');\n\nvar auth = {\n  \"client_id\": \"\",\n  \"client_secret\": \"\",\n  \"username\": \"\",\n  \"password\": \"\",\n};\n\nvar api = new netatmo(auth);\n\napi.on(\"error\", function(error) {\n    // When the \"error\" event is emitted, this is called\n    console.error('Netatmo threw an error: ' + error);\n});\n\napi.on(\"warning\", function(error) {\n    // When the \"warning\" event is emitted, this is called\n    console.log('Netatmo threw a warning: ' + error);\n});\n\n// Rest of program\n```\n\n## License\n\nMIT © [Ali Karbassi](http://karbassi.com)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkarbassi%2Fnetatmo","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkarbassi%2Fnetatmo","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkarbassi%2Fnetatmo/lists"}