kkosuge / nature-remo

πŸŒ… Nature Remo API client for JavaScript.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Nature Remo

npm version Build Status Codacy Badge Codacy Badge

yarn add nature-remo
# or
npm install nature-remo

Basic Usage

const NatureRemo = require('nature-remo')

const client = new NatureRemo.Cloud(process.env.NATURE_REMO_CLOUD_API_TOKEN)

async function turnOffAirConditioner() {
  const airconList = await client.listAircon()
  const aircon = airconList[0]

  await client.updateAirconSettings(aircon.id, {
    button: 'power-off',
  })

  console.log('Aircon: turned off')
}

async function turnOnAirConditioner() {
  const airconList = await client.listAircon()
  const aircon = airconList[0]

  await client.updateAirconSettings(aircon.id, {
    operation_mode: 'cool',
    temperature: 24,
  })

  console.log('Aircon: turned on')
}

You might want to obtain Nature Remo Cloud API token from https://home.nature.global.

  • RunKit Notebook: Check out RunKit Notebook for Nature Remo Cloud API example.
  • Code Example: See examples for various code examples.
  • Documents: See API Documents for detailed API documents.

API

const NatureRemo = require('nature-remo')

Cloud API

See Cloud API Documents.

const client = new NatureRemo.Cloud(NATURE_REMO_CLOUD_API_TOKEN)

Local API

See Local API Documents.

const client = new NatureRemo.Local(NATURE_REMO_LOCAL_ADDRESS)

Development

npm install

NATURE_REMO_CLOUD_TOKEN=<nature-remo-cloud-api-token>
NATURE_REMO_AIRCON_ID=<arbitorary aircon id>
npm test

About

πŸŒ… Nature Remo API client for JavaScript.

License:MIT License


Languages

Language:TypeScript 99.0%Language:JavaScript 1.0%