Skip to content

Commit

Permalink
fix: minor fixes to example configuration
Browse files Browse the repository at this point in the history
  • Loading branch information
dhutchison committed Nov 10, 2020
1 parent 7b36b59 commit e3b714b
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 11 deletions.
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Then, you can add the platform configuration to your config.json or you can conf

## Configuration

See config-sample.json for example
See `config-sample.json` for an example.

We will need to input your username and password for the Ebeco Connect app that you setup with the device.

Expand All @@ -32,13 +32,10 @@ We will need to input your username and password for the Ebeco Connect app that
"platform": "Ebeco",
"name": "Ebeco",
"plugin_map": {
"plugin_name": "homebridge-ebeco"
"plugin_name": "homebridge-ebeco"
},
"name": "Ebeco",
"username": "YOUR EBECO CONNECT USERNAME",
"password": "YOUR EBECO CONNECT PASSWORD",
"pollFrequency": value // A value between 500 and 60000 ms
}
"password": "YOUR EBECO CONNECT PASSWORD"
}
// End of the config
],
Expand All @@ -53,3 +50,7 @@ We will need to input your username and password for the Ebeco Connect app that
* All the devices will be added if you have more than one, choosing which not to add will be added to if more people are asking for it.
* Making a schedule through the Ebeco Connect app will override the changes in the plugin. So setting up a degree here and having a schedule to change it to something else in the app later will override the plugin.

## Plugin Development

TODO: add in details of how this is developed & tested. Docker-compose file for mocking etc.

9 changes: 4 additions & 5 deletions config-sample.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,11 @@
{
"platform": "Ebeco",
"plugin_map": {
"plugin_name": "homebridge-ebeco"
"plugin_name": "homebridge-ebeco"
},
"name": "Ebeco",
"username": "YOUR EBECO CONNECT E-MAIL/USERNAME",
"password": "YOUR EBECO CONNECT PASSWORD"
}
"name": "Ebeco",
"username": "YOUR EBECO CONNECT E-MAIL/USERNAME",
"password": "YOUR EBECO CONNECT PASSWORD"
}
]
}

0 comments on commit e3b714b

Please sign in to comment.