Skip to content

Magic Mirror module for displaying sensor data from Nature Remo

License

Notifications You must be signed in to change notification settings

mtatsuma/MMM-NatureRemo

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 

Repository files navigation

MMM-NatureRemo

Magic Mirror module for displaying sensor data from Nature Remo.

image

Nature Remo has a set of sensors and these sensor data can be fetched from Nature Remo cloud API. The cloud API is available for anyone who got Nature Remo smart controller by creating access token on the web page.

Installation

Clone this repository and place it on MagicMirror module directory.

$ cd ~/MagicMirror/modules
$ git clone https://github.com/mtatsuma/MMM-NatureRemo.git

Configuration example

      - module: MMM-NatureRemo
        position: top_left
        config:
          apiToken: xxxx
          deviceName: remo-1

Configuration options

Options Required Default Description
updateInterval 10 * 60 * 1000 Weather data update interval (miliseconds). Note: the access rate for Nature Remo cloud API is limited as 30 requests per 5 minutes.
retryDelay 5 * 1000 Delay for retry to get weather data (miliseconds)
title Nature Remo Title to display
apiBase https://api.nature.global/ Base URL of Nature Remo cloud API
apiEndpoint 1/devices API endpoint to be used for fetching sensor data
apiToken yes API access token to call Nature Remo cloud API.
deviceName Device name of the target Nature Remo device. If you don't set both of deviceName and deviceID, a device on the top of the device list will be selected.
deviceID Device ID of the target Nature Remo device. If you don't set both of deviceName and deviceID, a device on the top of the device list will be selected.
height 300px Height of the display box for this module.
width 500px Width of the display box for this module.
showTemperature true Show temperature data.
showHumidity true Show humidity data.
showIllumination true Show illumination data (Dark, Dim, Medium, Light and sensor data value).
showMotion true Show motion sensor data (motion detection time).
temperatureTitle Temperature: Title for temperature data
humidityTitle Humidity: Title for humidity data
illuminationTitle Illumination: Title for illumination data
motionTitle Motion Detect: Title for motion sensor data.
temperatureUnit Celsius Unit of temperature. Celsius or Fahrenheit
motionDateOffsetSeconds 0 Time offset (seconds) for motion detection time
motionDateHourFormat 24h If you set 12h, the time format of motion detection time is changed to 12 hour format

About

Magic Mirror module for displaying sensor data from Nature Remo

Resources

License

Stars

Watchers

Forks

Packages

No packages published