- General
- Authorization
- Programs and Options
- States
- Settings
- Power State
- Setpoint Temperature Refrigerator
- Setpoint Temperature Freezer
- Setpoint Temperature Bottle Cooler
- Setpoint Temperature Chiller
- Setpoint Temperature Wine Comp.
- Super Mode Refrigerator
- Super Mode Freezer
- Eco Mode
- Sabbath Mode
- Vacation Mode
- Fresh Mode
- Current Map
- Names of Maps
- Functional Light
- Functional Light Brightness
- Ambient Light
- Ambient Light Brightness
- Ambient Light Color
- Ambient Light Custom Color
- Events
- Commands
Oven Setpoint Temperature Change
Cooking | |||||
---|---|---|---|---|---|
Cleaning | |||||
Cooling |
Key
Cooking.Oven.Option.SetpointTemperature
Description
This event notifies that the intended temperature of an oven program has changed, e.g. by the user operating the oven locally.
Data type
Double
Possible values
see Setpoint Temperature option
Example
GET /api/homeappliances/{haid}/events
event: NOTIFY
data: {"items":[{"key":"Cooking.Oven.Option.SetpointTemperature", "timestamp":1479477178, "level":"hint", "handling":"none", "value":240, "unit":"°C"}]}
id: BOSCH-HCS01OVN1-7F930F92AD1403
Program Duration Change
Cooking | |||||
---|---|---|---|---|---|
Cleaning | |||||
Cooling |
Key
BSH.Common.Option.Duration
Description
This event notifies that the program duration has changed, e.g. by the user operating the home appliance locally.
Data type
Integer
Possible values
see Duration option
Example
GET /api/homeappliances/{haid}/events
event: NOTIFY
data: {"items":[{"key":"BSH.Common.Option.Duration","timestamp":1479477686,"level":"hint","handling":"none","value":1260,"unit":"seconds"}]}
id: BOSCH-HCS01OVN1-7F930F92AD1403
Fast Pre-heat Change
Cooking | |||||
---|---|---|---|---|---|
Cleaning | |||||
Cooling |
Key
Cooking.Oven.Option.FastPreHeat
Description
This event notifies that the fast pre-heat option of an oven program has changed, e.g. by the user operating the oven locally.
Data type
Boolean
Possible values
- true if enabled
- false otherwise
Example
GET /api/homeappliances/{haid}/events
event: NOTIFY
data: {"items":[{"key":"Cooking.Oven.Option.FastPreHeat", "timestamp":1479477178, "level":"hint", "handling":"none", "value":false}]}
id: BOSCH-HCS01OVN1-7F930F92AD1403
Start in Relative Change
Cooking | |||||
---|---|---|---|---|---|
Cleaning | |||||
Cooling |
Key
BSH.Common.Option.StartInRelative
Description
This event notifies that the delayed start of a program has changed, e.g. by the user operating the home appliance locally.
Data type
Integer
Possible values
Example
GET /api/homeappliances/{haid}/events
event: NOTIFY
data: {"items":[{"key":"BSH.Common.Option.StartInRelative", "timestamp":1479477686, "level":"hint", "handling":"none", "value":60, "unit":"seconds"}]}
id: BOSCH-HCS01OVN1-7F930F92AD1403
Washer Temperature Change
Cooking | |||||
---|---|---|---|---|---|
Cleaning | |||||
Cooling |
Key
LaundryCare.Washer.Option.Temperature
Description
This event notifies that the temperature of a washer program changed, e.g. by the user operating the washer locally.
Data type
Enumeration
Possible values
see Washer Temperature enumeration
Example
GET /api/homeappliances/{haid}/events
event: NOTIFY
data: {"items":[{"key":"LaundryCare.Washer.Option.Temperature", "timestamp":1479477686, "level":"hint", "handling":"none", "value":"LaundryCare.Washer.EnumType.Temperature.GC30"}]}
id: BOSCH-HCS01OVN1-7F930F92AD1403
Spin Speed Change
Cooking | |||||
---|---|---|---|---|---|
Cleaning | |||||
Cooling |
Key
LaundryCare.Washer.Option.SpinSpeed
Description
This event notifies that the spin speed of a washer program changed, e.g. by the user operating the washer locally.
Data type
Enumeration
Possible values
Example
GET /api/homeappliances/{haid}/events
event: NOTIFY
data: {"items":[{"key":"LaundryCare.Washer.Option.SpinSpeed", "timestamp":1479477686, "level":"hint", "handling":"none", "value":"LaundryCare.Washer.EnumType.SpinSpeed.RPM800"}]}
id: BOSCH-HCS01OVN1-7F930F92AD1403
Drying Target Change
Cooking | |||||
---|---|---|---|---|---|
Cleaning | |||||
Cooling |
Key
LaundryCare.Dryer.Option.DryingTarget
Description
This event notifies that the drying target of a dryer program changed, e.g. by the user operating the washer locally.
Data type
Enumeration
Possible values
Example
GET /api/homeappliances/{haid}/events
event: NOTIFY
data: {"items":[{"key":"LaundryCare.Dryer.Option.DryingTarget", "timestamp":1479477686, "level":"hint", "handling":"none", "value":"LaundryCare.Dryer.EnumType.DryingTarget.CupboardDry"}]}
id: BOSCH-HCS01OVN1-7F930F92AD1403
Bean Amount Change
Cooking | |||||
---|---|---|---|---|---|
Cleaning | |||||
Cooling |
Key
ConsumerProducts.CoffeeMaker.Option.BeanAmount
Description
This event notifies that the bean amount of a coffee machine program has changed, e.g. by the user operating the coffee machine locally.
Data type
Enumeration
Possible values
Example
GET /api/homeappliances/{haid}/events
event: NOTIFY
data: {"items":[{"key":"ConsumerProducts.CoffeeMaker.Option.BeanAmount", "timestamp":1479477686, "level":"hint", "handling":"none", "value":"ConsumerProducts.CoffeeMaker.EnumType.BeanAmount.VeryStrong"}]}
id: BOSCH-HCS06COM1-F8C8A682108B2A
Fill Quantity Change
Cooking | |||||
---|---|---|---|---|---|
Cleaning | |||||
Cooling |
Key
ConsumerProducts.CoffeeMaker.Option.FillQuantity
Description
This event notifies that the fill quantity of a coffee machine program has changed, e.g. by the user operating the coffee machine locally.
Data type
Integer
Possible values
Example
GET /api/homeappliances/{haid}/events
event: NOTIFY
data: {"items":[{"key":"ConsumerProducts.CoffeeMaker.Option.FillQuantity", "timestamp":1479477686, "level":"hint", "handling":"none", "value":50, "unit":"ml"}]}
id: BOSCH-HCS06COM1-F8C8A682108B2A
Coffee Temperature Change
Cooking | |||||
---|---|---|---|---|---|
Cleaning | |||||
Cooling |
Key
ConsumerProducts.CoffeeMaker.Option.CoffeeTemperature
Description
This event notifies that the coffee temperature of a coffee machine program has changed, e.g. by the user operating the coffee machine locally.
Data type
Enumeration
Possible values
see Coffee Temperature enumeration
Example
GET /api/homeappliances/{haid}/events
event: NOTIFY
data: {"items":[{"key":"ConsumerProducts.CoffeeMaker.Option.CoffeeTemperature", "timestamp":1479477686, "level":"hint", "handling":"none", "value":"ConsumerProducts.CoffeeMaker.EnumType.CoffeeTemperature.96C"}]}
id: BOSCH-HCS06COM1-F8C8A682108B2A
Fan Setting Change
Cooking | |||||
---|---|---|---|---|---|
Cleaning | |||||
Cooling |
Key
Cooking.Common.Option.Hood.VentingLevel
Description
This event notifies that the fan setting of a hood program has changed, e.g. by the user operating the hood locally.
Data type
Enumeration
Possible values
Example
GET /api/homeappliances/{haid}/events
event: NOTIFY
data: {"items":[{"key":"Cooking.Common.Option.Hood.VentingLevel", "timestamp":1479477686, "level":"hint", "handling":"none", "value":"Cooking.Hood.EnumType.Stage.FanStage01"}]}
id: BOSCH-HCS08HOD1-F8C8A6821081GB
Intensive Setting Change
Cooking | |||||
---|---|---|---|---|---|
Cleaning | |||||
Cooling |
Key
Cooking.Common.Option.Hood.IntensiveLevel
Description
This event notifies that the intensive setting of a hood program has changed, e.g. by the user operating the hood locally.
Data type
Enumeration
Possible values
see Intensive Setting enumeration
Example
GET /api/homeappliances/{haid}/events
event: NOTIFY
data: {"items":[{"key":"Cooking.Common.Option.Hood.IntensiveLevel", "timestamp":1479477686, "level":"hint", "handling":"none", "value":"Cooking.Hood.EnumType.IntensiveStage.IntensiveStage1"}]}
id: BOSCH-HCS08HOD1-F8C8A6821081GB
Reference Map ID Change
Cooking | |||||
---|---|---|---|---|---|
Cleaning | |||||
Cooling |
Key
ConsumerProducts.CleaningRobot.Option.ReferenceMapId
Description
This event notifies that the reference map id of a cleaning robot program has changed.
Data type
Enumeration
Possible values
see Reference Map ID enumeration
Example
GET /api/homeappliances/{haid}/events
event: NOTIFY
data: {"items":[{"key":"ConsumerProducts.CleaningRobot.Option.ReferenceMapId", "timestamp":1479477686, "level":"hint", "handling":"none", "value":"ConsumerProducts.CleaningRobot.EnumType.AvailableMaps.Map2"}]}
id: BOSCH-HCS09CLR1-7F930F92ADWW03
Cleaning Mode Change
Cooking | |||||
---|---|---|---|---|---|
Cleaning | |||||
Cooling |
Key
ConsumerProducts.CleaningRobot.Option.CleaningMode
Description
This event notifies that the cleaning mode of a cleaning robot program has changed.
Data type
Enumeration
Possible values
Example
GET /api/homeappliances/{haid}/events
event: NOTIFY
data: {"items":[{"key":"ConsumerProducts.CleaningRobot.Option.CleaningMode", "timestamp":1479477686, "level":"hint", "handling":"none", "value":"ConsumerProducts.CleaningRobot.EnumType.CleaningModes.Silent"}]}
id: BOSCH-HCS09CLR1-7F930F92ADWW03