home_iot_api v1.0.0
home_iot_api
HomeIotApi - JavaScript client for home_iot_api The API for the EatBacon IOT project This SDK is automatically generated by the Swagger Codegen project:
- API version: 1.0.0
- Package version: 1.0.0
- Build package: io.swagger.codegen.v3.generators.javascript.JavaScriptClientCodegen
Installation
For Node.js
npm
To publish the library as a npm, please follow the procedure in "Publishing npm packages".
Then install it via:
npm install home_iot_api --save
git
If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:
npm install GIT_USER_ID/GIT_REPO_ID --save
For browser
The library also works in the browser environment via npm and browserify. After following
the above steps with Node.js and installing browserify with npm install -g browserify
,
perform the following (assuming main.js is your entry file):
browserify main.js > bundle.js
Then include bundle.js in the HTML pages.
Webpack Configuration
Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:
module: {
rules: [
{
parser: {
amd: false
}
}
]
}
Getting Started
Please follow the installation instruction and execute the following JS code:
var HomeIotApi = require('home_iot_api');
var api = new HomeIotApi.DeviceApi()
var opts = {
'skip': 56, // {Number} number of records to skip
'limit': 56 // {Number} max number of records to return
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.getDevices(opts, callback);
Documentation for API Endpoints
All URIs are relative to /
Class | Method | HTTP request | Description |
---|---|---|---|
HomeIotApi.DeviceApi | getDevices | GET /devices | |
HomeIotApi.DeviceApi | register | POST /devices | |
HomeIotApi.EnvironmentApi | getForecast | GET /temperature/forecast/{days} | |
HomeIotApi.EnvironmentApi | getHeaterState | GET /temperature/{zoneId}/heater | |
HomeIotApi.EnvironmentApi | getZoneTemperature | GET /temperature/{zoneId} | |
HomeIotApi.EnvironmentApi | setHeaterState | POST /temperature/{zoneId}/heater/{state} | |
HomeIotApi.EnvironmentApi | temperatureSummary | GET /temperature | |
HomeIotApi.ZWaveApi | getLightingSummary | GET /lightingSummary | |
HomeIotApi.ZWaveApi | getSwitchState | GET /lighting/switches/{deviceId} | |
HomeIotApi.ZWaveApi | setDimmer | POST /lighting/dimmers/{deviceId}/{value} | |
HomeIotApi.ZWaveApi | setDimmerTimer | POST /lighting/dimmers/{deviceId}/{value}/timer/{timeunit} | |
HomeIotApi.ZWaveApi | setSwitch | POST /lighting/switches/{deviceId}/{value} | |
HomeIotApi.ZWaveApi | setSwitchTimer | POST /lighting/switches/{deviceId}/{value}/timer/{minutes} | |
HomeIotApi.ZonesApi | getZones | GET /zones | |
HomeIotApi.ZonesApi | quietZone | GET /zones/{zoneId}/quiet |
Documentation for Models
- HomeIotApi.ApiResponse
- HomeIotApi.City
- HomeIotApi.DeviceRegistrationInfo
- HomeIotApi.DeviceState
- HomeIotApi.Forecast
- HomeIotApi.ForecastResponse
- HomeIotApi.ForecastTemperature
- HomeIotApi.HeaterState
- HomeIotApi.LightingSummary
- HomeIotApi.LightingZone
- HomeIotApi.LightingZoneStatus
- HomeIotApi.TemperatueZoneStatus
- HomeIotApi.TemperatureSummary
- HomeIotApi.TemperatureZone
- HomeIotApi.WeatherForecast
Documentation for Authorization
All endpoints do not require authorization.
9 months ago