Skip to content
This repository has been archived by the owner on Oct 4, 2022. It is now read-only.

Commit

Permalink
edit README
Browse files Browse the repository at this point in the history
  • Loading branch information
takeyaqa committed Feb 27, 2021
1 parent dcf6104 commit ace987e
Showing 1 changed file with 33 additions and 1 deletion.
34 changes: 33 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,37 @@
# Homebridge Nature Remo Platform

[![npm](https://badgen.net/npm/v/@takeya0x86/homebridge-nature-remo-platform?icon=npm&label)](https://www.npmjs.com/package/@takeya0x86/homebridge-nature-remo-platform)
[![Build and Lint](https://github.com/takeya0x86/homebridge-nature-remo-platform/actions/workflows/build.yml/badge.svg)](https://github.com/takeya0x86/homebridge-nature-remo-platform/actions/workflows/build.yml)

Homebridge plugin for Nature Remo which supports lights and air conditioners.
Homebridge plugin for Nature Remo which supports lights and air conditioners. **This plugin is unofficial.**

## Requirements

* An access token generated from https://developer.nature.global/.

## Installation

1. Search for `@takeya0x86/homebridge-nature-remo-platform` on the plugin screen of [Homebridge Config UI X](https://github.com/oznu/homebridge-config-ui-x).
2. Click `INSTALL`.

## Configuration

1. Input your access token into `Access Token` in config window.
2. Click `SAVE` and restart Homebridge.
3. The plugin detect automatically your Nature Remo devices and configured appliances.

## Suppoerted appliances

### Sensors (Nature Remo build-in)

* Temperature
* Humidity
* Illuminance

### Lights

Allows for on/off controls.

### Air conditioners

Allows for on/off, temperature and mode changing controls. The mode changing only supports heating and cooling. Auto, dehumidification, blowing and any other mode are not supported.

0 comments on commit ace987e

Please sign in to comment.