Swagger UIswagger

Nature API
 1.0.0 

[ Base URL: api.nature.global/ ]
/swagger.yml

Read/Write Nature Remo

Models

#/definitions/UserUser{
idIdstring($uuid)
nicknamestring
}
Devices[#/definitions/DeviceDevice{...}]
#/definitions/DeviceDevice{
idIdstring($uuid)
namestring
temperature_offsetnumber
humidity_offsetnumber
created_atDateTimestring($date-time)
updated_atDateTimestring($date-time)
firmware_versionstring
newest_events{
te#/definitions/SensorValueSensorValue{
description:

The reference key to SensorValue means “te” = temperature, “hu” = humidity.

valuenumber($float)
created_atDateTimestring($date-time)
}
hu#/definitions/SensorValueSensorValue{
description:

The reference key to SensorValue means “te” = temperature, “hu” = humidity.

valuenumber($float)
created_atDateTimestring($date-time)
}
}
}
#/definitions/DeviceCoreDeviceCore{
idIdstring($uuid)
namestring
temperature_offsetnumber
humidity_offsetnumber
created_atDateTimestring($date-time)
updated_atDateTimestring($date-time)
firmware_versionstring
}
#/definitions/ApplianceAppliance{
idIdstring($uuid)
device#/definitions/DeviceCoreDeviceCore{
idIdstring($uuid)
namestring
temperature_offsetnumber
humidity_offsetnumber
created_atDateTimestring($date-time)
updated_atDateTimestring($date-time)
firmware_versionstring
}
model#/definitions/ApplianceModelApplianceModel{
idIdstring($uuid)
manufacturerstring
remote_namestring
namestring
imageImagestring

Basename of the image file included in the app. Ex: “ico_ac_1”

}
nicknamestring
imageImagestring

Basename of the image file included in the app. Ex: “ico_ac_1”

typeApplianceTypestring
default: AC

Type of the appliance. “AC” (Air conditioner) is 1st class citizen appliance, which is included in our IRDB (InfraRed signals DataBase). The “ApplianceModel” stores meta data about the appliance. We provide AC specific UI. Everything else is "IR". We just learn the signals from the remote and store them, and when users tap the button on the smartphone app, our server sends it through Remo.

Enum:
Array [ 2 ]
settings#/definitions/AirConParamsAirConParams{
tempTemperaturestring
x-example: List [ "", "0", "38", "80" ]

The temperature in string format. The unit is described in Aircon object. The range of Temperatures which the air conditioner accepts depends on the air conditioner model and operation mode. Check the ‘AirConRangeMode’ information in the response for the range of the particular air conditioner model and operation mode.

modeOperationModestring

The range of OperationModes which the air conditioner accepts depends on the air conditioner model. Check the ‘AirConRangeMode’ information in the response for the range of the particular air conditioner model.

Enum:
Array [ 6 ]
volAirVolumestring

Empty means automatic. Numbers express the amount of volume. The range of AirVolumes which the air conditioner accepts depends on the air conditioner model and operation mode. Check the ‘AirConRangeMode’ information in the response for the range of the particular air conditioner model and operation mode.

Enum:
Array [ 12 ]
dirAirDirectionstring

Empty means automatic.

Enum:
Array [ 1 ]
buttonButtonstring

Specify “power-off” always if you want the air conditioner powered off. Empty means powered on.

Enum:
Array [ 2 ]
}
aircon#/definitions/AirConAirCon{
range{
modes{
cool#/definitions/AirConRangeModeAirConRangeMode{
temp[Temperaturestring
x-example: List [ "", "0", "38", "80" ]

The temperature in string format. The unit is described in Aircon object. The range of Temperatures which the air conditioner accepts depends on the air conditioner model and operation mode. Check the ‘AirConRangeMode’ information in the response for the range of the particular air conditioner model and operation mode.

]
vol[AirVolumestring

Empty means automatic. Numbers express the amount of volume. The range of AirVolumes which the air conditioner accepts depends on the air conditioner model and operation mode. Check the ‘AirConRangeMode’ information in the response for the range of the particular air conditioner model and operation mode.

Enum:
Array [ 12 ]
]
dir[AirDirectionstring

Empty means automatic.

Enum:
Array [ 1 ]
]
}
warm#/definitions/AirConRangeModeAirConRangeMode{
temp[Temperaturestring
x-example: List [ "", "0", "38", "80" ]

The temperature in string format. The unit is described in Aircon object. The range of Temperatures which the air conditioner accepts depends on the air conditioner model and operation mode. Check the ‘AirConRangeMode’ information in the response for the range of the particular air conditioner model and operation mode.

]
vol[AirVolumestring

Empty means automatic. Numbers express the amount of volume. The range of AirVolumes which the air conditioner accepts depends on the air conditioner model and operation mode. Check the ‘AirConRangeMode’ information in the response for the range of the particular air conditioner model and operation mode.

Enum:
Array [ 12 ]
]
dir[AirDirectionstring

Empty means automatic.

Enum:
Array [ 1 ]
]
}
dry#/definitions/AirConRangeModeAirConRangeMode{
temp[Temperaturestring
x-example: List [ "", "0", "38", "80" ]

The temperature in string format. The unit is described in Aircon object. The range of Temperatures which the air conditioner accepts depends on the air conditioner model and operation mode. Check the ‘AirConRangeMode’ information in the response for the range of the particular air conditioner model and operation mode.

]
vol[AirVolumestring

Empty means automatic. Numbers express the amount of volume. The range of AirVolumes which the air conditioner accepts depends on the air conditioner model and operation mode. Check the ‘AirConRangeMode’ information in the response for the range of the particular air conditioner model and operation mode.

Enum:
Array [ 12 ]
]
dir[AirDirectionstring

Empty means automatic.

Enum:
Array [ 1 ]
]
}
blow#/definitions/AirConRangeModeAirConRangeMode{
temp[Temperaturestring
x-example: List [ "", "0", "38", "80" ]

The temperature in string format. The unit is described in Aircon object. The range of Temperatures which the air conditioner accepts depends on the air conditioner model and operation mode. Check the ‘AirConRangeMode’ information in the response for the range of the particular air conditioner model and operation mode.

]
vol[AirVolumestring

Empty means automatic. Numbers express the amount of volume. The range of AirVolumes which the air conditioner accepts depends on the air conditioner model and operation mode. Check the ‘AirConRangeMode’ information in the response for the range of the particular air conditioner model and operation mode.

Enum:
Array [ 12 ]
]
dir[AirDirectionstring

Empty means automatic.

Enum:
Array [ 1 ]
]
}
auto#/definitions/AirConRangeModeAirConRangeMode{
temp[Temperaturestring
x-example: List [ "", "0", "38", "80" ]

The temperature in string format. The unit is described in Aircon object. The range of Temperatures which the air conditioner accepts depends on the air conditioner model and operation mode. Check the ‘AirConRangeMode’ information in the response for the range of the particular air conditioner model and operation mode.

]
vol[AirVolumestring

Empty means automatic. Numbers express the amount of volume. The range of AirVolumes which the air conditioner accepts depends on the air conditioner model and operation mode. Check the ‘AirConRangeMode’ information in the response for the range of the particular air conditioner model and operation mode.

Enum:
Array [ 12 ]
]
dir[AirDirectionstring

Empty means automatic.

Enum:
Array [ 1 ]
]
}
}
fixedButtons[Buttonstring

Specify “power-off” always if you want the air conditioner powered off. Empty means powered on.

Enum:
Array [ 2 ]
]
}
tempUnitstringEnum:
Array [ 3 ]
}
signals[#/definitions/SignalSignal{
idIdstring($uuid)
namestring
imageImagestring

Basename of the image file included in the app. Ex: “ico_ac_1”

}
]
}
#/definitions/AirConParamsAirConParams{
tempTemperaturestring
x-example: List [ "", "0", "38", "80" ]

The temperature in string format. The unit is described in Aircon object. The range of Temperatures which the air conditioner accepts depends on the air conditioner model and operation mode. Check the ‘AirConRangeMode’ information in the response for the range of the particular air conditioner model and operation mode.

modeOperationModestring

The range of OperationModes which the air conditioner accepts depends on the air conditioner model. Check the ‘AirConRangeMode’ information in the response for the range of the particular air conditioner model.

Enum:
Array [ 6 ]
volAirVolumestring

Empty means automatic. Numbers express the amount of volume. The range of AirVolumes which the air conditioner accepts depends on the air conditioner model and operation mode. Check the ‘AirConRangeMode’ information in the response for the range of the particular air conditioner model and operation mode.

Enum:
Array [ 12 ]
dirAirDirectionstring

Empty means automatic.

Enum:
Array [ 1 ]
buttonButtonstring

Specify “power-off” always if you want the air conditioner powered off. Empty means powered on.

Enum:
Array [ 2 ]
}
#/definitions/AirConAirCon{
range{
modes{
cool#/definitions/AirConRangeModeAirConRangeMode{
temp[Temperaturestring
x-example: List [ "", "0", "38", "80" ]

The temperature in string format. The unit is described in Aircon object. The range of Temperatures which the air conditioner accepts depends on the air conditioner model and operation mode. Check the ‘AirConRangeMode’ information in the response for the range of the particular air conditioner model and operation mode.

]
vol[AirVolumestring

Empty means automatic. Numbers express the amount of volume. The range of AirVolumes which the air conditioner accepts depends on the air conditioner model and operation mode. Check the ‘AirConRangeMode’ information in the response for the range of the particular air conditioner model and operation mode.

Enum:
Array [ 12 ]
]
dir[AirDirectionstring

Empty means automatic.

Enum:
Array [ 1 ]
]
}
warm#/definitions/AirConRangeModeAirConRangeMode{
temp[Temperaturestring
x-example: List [ "", "0", "38", "80" ]

The temperature in string format. The unit is described in Aircon object. The range of Temperatures which the air conditioner accepts depends on the air conditioner model and operation mode. Check the ‘AirConRangeMode’ information in the response for the range of the particular air conditioner model and operation mode.

]
vol[AirVolumestring

Empty means automatic. Numbers express the amount of volume. The range of AirVolumes which the air conditioner accepts depends on the air conditioner model and operation mode. Check the ‘AirConRangeMode’ information in the response for the range of the particular air conditioner model and operation mode.

Enum:
Array [ 12 ]
]
dir[AirDirectionstring

Empty means automatic.

Enum:
Array [ 1 ]
]
}
dry#/definitions/AirConRangeModeAirConRangeMode{
temp[Temperaturestring
x-example: List [ "", "0", "38", "80" ]

The temperature in string format. The unit is described in Aircon object. The range of Temperatures which the air conditioner accepts depends on the air conditioner model and operation mode. Check the ‘AirConRangeMode’ information in the response for the range of the particular air conditioner model and operation mode.

]
vol[AirVolumestring

Empty means automatic. Numbers express the amount of volume. The range of AirVolumes which the air conditioner accepts depends on the air conditioner model and operation mode. Check the ‘AirConRangeMode’ information in the response for the range of the particular air conditioner model and operation mode.

Enum:
Array [ 12 ]
]
dir[AirDirectionstring

Empty means automatic.

Enum:
Array [ 1 ]
]
}
blow#/definitions/AirConRangeModeAirConRangeMode{
temp[Temperaturestring
x-example: List [ "", "0", "38", "80" ]

The temperature in string format. The unit is described in Aircon object. The range of Temperatures which the air conditioner accepts depends on the air conditioner model and operation mode. Check the ‘AirConRangeMode’ information in the response for the range of the particular air conditioner model and operation mode.

]
vol[AirVolumestring

Empty means automatic. Numbers express the amount of volume. The range of AirVolumes which the air conditioner accepts depends on the air conditioner model and operation mode. Check the ‘AirConRangeMode’ information in the response for the range of the particular air conditioner model and operation mode.

Enum:
Array [ 12 ]
]
dir[AirDirectionstring

Empty means automatic.

Enum:
Array [ 1 ]
]
}
auto#/definitions/AirConRangeModeAirConRangeMode{
temp[Temperaturestring
x-example: List [ "", "0", "38", "80" ]

The temperature in string format. The unit is described in Aircon object. The range of Temperatures which the air conditioner accepts depends on the air conditioner model and operation mode. Check the ‘AirConRangeMode’ information in the response for the range of the particular air conditioner model and operation mode.

]
vol[AirVolumestring

Empty means automatic. Numbers express the amount of volume. The range of AirVolumes which the air conditioner accepts depends on the air conditioner model and operation mode. Check the ‘AirConRangeMode’ information in the response for the range of the particular air conditioner model and operation mode.

Enum:
Array [ 12 ]
]
dir[AirDirectionstring

Empty means automatic.

Enum:
Array [ 1 ]
]
}
}
fixedButtons[Buttonstring

Specify “power-off” always if you want the air conditioner powered off. Empty means powered on.

Enum:
Array [ 2 ]
]
}
tempUnitstringEnum:
Array [ 3 ]
}
#/definitions/AirConRangeModeAirConRangeMode{
temp[Temperaturestring
x-example: List [ "", "0", "38", "80" ]

The temperature in string format. The unit is described in Aircon object. The range of Temperatures which the air conditioner accepts depends on the air conditioner model and operation mode. Check the ‘AirConRangeMode’ information in the response for the range of the particular air conditioner model and operation mode.

]
vol[AirVolumestring

Empty means automatic. Numbers express the amount of volume. The range of AirVolumes which the air conditioner accepts depends on the air conditioner model and operation mode. Check the ‘AirConRangeMode’ information in the response for the range of the particular air conditioner model and operation mode.

Enum:
Array [ 12 ]
]
dir[AirDirectionstring

Empty means automatic.

Enum:
Array [ 1 ]
]
}
#/definitions/SignalSignal{
idIdstring($uuid)
namestring
imageImagestring

Basename of the image file included in the app. Ex: “ico_ac_1”

}
#/definitions/ApplianceModelApplianceModel{
idIdstring($uuid)
manufacturerstring
remote_namestring
namestring
imageImagestring

Basename of the image file included in the app. Ex: “ico_ac_1”

}
#/definitions/ApplianceModelAndParamApplianceModelAndParam{
model#/definitions/ApplianceModelApplianceModel{
idIdstring($uuid)
manufacturerstring
remote_namestring
namestring
imageImagestring

Basename of the image file included in the app. Ex: “ico_ac_1”

}
params#/definitions/AirConParamsAirConParams{
tempTemperaturestring
x-example: List [ "", "0", "38", "80" ]

The temperature in string format. The unit is described in Aircon object. The range of Temperatures which the air conditioner accepts depends on the air conditioner model and operation mode. Check the ‘AirConRangeMode’ information in the response for the range of the particular air conditioner model and operation mode.

modeOperationModestring

The range of OperationModes which the air conditioner accepts depends on the air conditioner model. Check the ‘AirConRangeMode’ information in the response for the range of the particular air conditioner model.

Enum:
Array [ 6 ]
volAirVolumestring

Empty means automatic. Numbers express the amount of volume. The range of AirVolumes which the air conditioner accepts depends on the air conditioner model and operation mode. Check the ‘AirConRangeMode’ information in the response for the range of the particular air conditioner model and operation mode.

Enum:
Array [ 12 ]
dirAirDirectionstring

Empty means automatic.

Enum:
Array [ 1 ]
buttonButtonstring

Specify “power-off” always if you want the air conditioner powered off. Empty means powered on.

Enum:
Array [ 2 ]
}
}
ApplianceTypestring
default: AC

Type of the appliance. “AC” (Air conditioner) is 1st class citizen appliance, which is included in our IRDB (InfraRed signals DataBase). The “ApplianceModel” stores meta data about the appliance. We provide AC specific UI. Everything else is "IR". We just learn the signals from the remote and store them, and when users tap the button on the smartphone app, our server sends it through Remo.

Enum:
Array [ 2 ]
Idstring($uuid)
Imagestring

Basename of the image file included in the app. Ex: “ico_ac_1”

DateTimestring($date-time)
OperationModestring

The range of OperationModes which the air conditioner accepts depends on the air conditioner model. Check the ‘AirConRangeMode’ information in the response for the range of the particular air conditioner model.

Enum:
Array [ 6 ]
Temperaturestring
x-example: List [ "", "0", "38", "80" ]

The temperature in string format. The unit is described in Aircon object. The range of Temperatures which the air conditioner accepts depends on the air conditioner model and operation mode. Check the ‘AirConRangeMode’ information in the response for the range of the particular air conditioner model and operation mode.

AirVolumestring

Empty means automatic. Numbers express the amount of volume. The range of AirVolumes which the air conditioner accepts depends on the air conditioner model and operation mode. Check the ‘AirConRangeMode’ information in the response for the range of the particular air conditioner model and operation mode.

Enum:
Array [ 12 ]
AirDirectionstring

Empty means automatic.

Enum:
Array [ 1 ]
Buttonstring

Specify “power-off” always if you want the air conditioner powered off. Empty means powered on.

Enum:
Array [ 2 ]
#/definitions/SensorValueSensorValue{
description:

The reference key to SensorValue means “te” = temperature, “hu” = humidity.

valuenumber($float)
created_atDateTimestring($date-time)
}
Online validator badge