Hood Programs

The following list contains all hood programs, which are supported by the API. Please note that not all programs are supported for a specific hood model. Therefore, we recommend to use the available program interface to check the program availability.

 

Automatic Mode

Key

Cooking.Common.Program.Hood.Automatic

Description

In automatic mode, a sensor in the extractor hood detects the intensity of the cooking and roasting fumes. Depending on the sensor setting, the fan automatically switches to another fan setting. If you monitor the home appliance, you will receive the following additional events:

  • Cooking.Common.Option.Hood.VentingLevel
  • Cooking.Common.Option.Hood.IntensiveLevel
  • BSH.Common.Option.ElapsedProgramTime

Example

PUT /api/homeappliances/{haid}/programs/active


{
    "data": {
        "key": "Cooking.Common.Program.Hood.Automatic"
    }
}

 

Fan Setting

Key

Cooking.Common.Program.Hood.Venting

Description

Manual program which allows the user to select fan setting or intensive setting. If you monitor the home appliance, you will receive the following events:

  • BSH.Common.Option.ElapsedProgramTime

Example

PUT /api/homeappliances/{haid}/programs/active


{
    "data": {
        "key": "Cooking.Common.Program.Hood.Venting",
        "options": [
            {
                "key": "Cooking.Common.Option.Hood.IntensiveLevel",
                "value": "Cooking.Hood.EnumType.IntensiveStage.IntensiveStage1"
            }
        ]
    }
}

 

Fan Run-on

Key

Cooking.Common.Program.Hood.DelayedShutOff

Description

The fan run-on ensures that remaining odours will be eliminated after cooking. Afterwards the fan switches off automatically. If you monitor the home appliance, you will receive the following events:

  • BSH.Common.Option.Duration
  • BSH.Common.Option.ElapsedProgramTime
  • BSH.Common.Option.ProgramProgress
  • BSH.Common.Event.ProgramFinished

Example

PUT /api/homeappliances/{haid}/programs/active


{
    "data":{
        "key":"Cooking.Common.Program.Hood.DelayedShutOff"
    }
}

 

Options

The following list contains all options which are supported by the API. Please note that not all options are supported by a program. Therefore, we recommend to use the program constraints endpoint to check the option availability.

 

Example

GET /api/homeappliances/{haid}/programs/available/Cooking.Common.Program.Hood.Venting


{
    "data": {
        "key": "Cooking.Common.Program.Hood.Venting",
        "options": [
            {
                "key": "Cooking.Common.Option.Hood.VentingLevel",
                "type": "Cooking.Hood.EnumType.Stage",
                "constraints": {
                    "allowedvalues": [
                        "Cooking.Hood.EnumType.Stage.FanOff",
                        "Cooking.Hood.EnumType.Stage.FanStage01",
                        "Cooking.Hood.EnumType.Stage.FanStage02",
                        "Cooking.Hood.EnumType.Stage.FanStage03"
                    ]
                }
            },
            {
                "key": "Cooking.Common.Option.Hood.IntensiveLevel",
                "type": "Cooking.Hood.EnumType.IntensiveStage",
                "constraints": {
                    "allowedvalues": [
                        "Cooking.Hood.EnumType.IntensiveStage.IntensiveStageOff",
                        "Cooking.Hood.EnumType.IntensiveStage.IntensiveStage1",
                        "Cooking.Hood.EnumType.IntensiveStage.IntensiveStage2"
                    ]
                }
            }
        ]
    }
}