Hudu API
This is a wrapper for the HomeWizard rest API.
Installation
Add this line to your application's Gemfile:
gem 'homewizard'And then execute:
$ bundle install
Or install it yourself as:
$ gem install homewizard
Usage
Before you start making the requests to API provide the endpoint using the configuration wrapping.
require 'homewizard'
require 'logger'
# use do block
HomeWizard.configure do |config|
config.endpoint = ENV['HOMEWIZARD_P1_API_HOST'].downcase
end
# or configure with options hash
client = HomeWizard.client({ logger: Logger.new('debug.log) })
# check api version
return unless if client.device_info.api_version.eql? 'v1'
# get last data
data = client.recent_data
if data.active_power_w < 0
# do something to use energy
endResources
Endpoint for data related requests
| Resource | API endpoint |
|---|---|
| .recent_data | /api/v1/data |
| .socket_state | /api/v1/state |
| .telegram | /api/v1/telegram |
| .identify | /api/v1/identify |
Publishing
- Update version in version.rb.
- Add release to CHANGELOG.md
- Commit.
- Test build.
> rake build
- Release
> rake release
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/jancotanis/homewizard.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).