search

thoukydides / homebridge-homeconnect

Home Connect home appliances plugin for Homebridge
https://www.thouky.co.uk
ISC License
134 stars 14 forks source link

HomeConnect API unexpected values (SHP78CM5N/22) #222

Closed marksanctuary closed 8 months ago

marksanctuary commented 8 months ago

Plugin Version

0.37.11

Home Connect Appliance(s)

Bosch Dishwasher SHP78CM5N/22

Log File

[1/12/2024, 6:42:36 AM] [HomeConnect] // Union types
[1/12/2024, 6:42:36 AM] [HomeConnect] export type FlexSprayIntensity =
[1/12/2024, 6:42:36 AM] [HomeConnect]     'Dishcare.Dishwasher.EnumType.FlexSpray.Intensity.Delicate' // (unrecognised)
[1/12/2024, 6:42:36 AM] [HomeConnect]   | 'Dishcare.Dishwasher.EnumType.FlexSpray.Intensity.Heavy'
[1/12/2024, 6:42:36 AM] [HomeConnect]   | 'Dishcare.Dishwasher.EnumType.FlexSpray.Intensity.Normal';
[1/12/2024, 6:42:36 AM] [HomeConnect] 
[1/12/2024, 6:42:36 AM] [HomeConnect] // Option
[1/12/2024, 6:42:36 AM] [HomeConnect] export interface OptionValues {
[1/12/2024, 6:42:36 AM] [HomeConnect]     'BSH.Common.Option.EnergyForecast'?:                   number;
[1/12/2024, 6:42:36 AM] [HomeConnect]     'BSH.Common.Option.RemainingProgramTime'?:             number;
[1/12/2024, 6:42:36 AM] [HomeConnect]     'BSH.Common.Option.RemainingProgramTimeIsEstimated'?:  boolean;
[1/12/2024, 6:42:36 AM] [HomeConnect]     'BSH.Common.Option.StartInRelative'?:                  number;
[1/12/2024, 6:42:36 AM] [HomeConnect]     'BSH.Common.Option.WaterForecast'?:                    number;
[1/12/2024, 6:42:36 AM] [HomeConnect]     'Dishcare.Dishwasher.Option.EnergySafe'?:              boolean;
[1/12/2024, 6:42:36 AM] [HomeConnect]     'Dishcare.Dishwasher.Option.FlexSpray.BackLeft'?:      FlexSprayIntensity; // (unrecognised)
[1/12/2024, 6:42:36 AM] [HomeConnect]     'Dishcare.Dishwasher.Option.FlexSpray.BackRight'?:     FlexSprayIntensity; // (unrecognised)
[1/12/2024, 6:42:36 AM] [HomeConnect]     'Dishcare.Dishwasher.Option.FlexSpray.FrontLeft'?:     FlexSprayIntensity;
[1/12/2024, 6:42:36 AM] [HomeConnect]     'Dishcare.Dishwasher.Option.FlexSpray.FrontRight'?:    FlexSprayIntensity;
[1/12/2024, 6:42:36 AM] [HomeConnect]     'Dishcare.Dishwasher.Option.FlexSpray.Type'?:          FlexSprayType;
[1/12/2024, 6:42:36 AM] [HomeConnect]     'Dishcare.Dishwasher.Option.HalfLoad'?:                boolean;
[1/12/2024, 6:42:36 AM] [HomeConnect]     'Dishcare.Dishwasher.Option.HygienePlus'?:             boolean;
[1/12/2024, 6:42:36 AM] [HomeConnect]     'Dishcare.Dishwasher.Option.ZeoliteDry'?:              boolean;
[1/12/2024, 6:42:36 AM] [HomeConnect] }

Additional Information

And there it is, the last Intensity. I think I have all the settings covered for FlexSpray on the Dishwasher.

marksanctuary commented 8 months ago

One other mention is I was looking at the api-value-types.ts file and this property below is listed twice. Not sure if that was intentional.

'ConsumerProducts.CoffeeMaker.Program.Beverage.CaffeGrande'

thoukydides commented 8 months ago

Thanks for your perserverence!

v0.37.12 should reveal whether that's all of the options...

marksanctuary commented 8 months ago

I am also a developer so I seem to have the tenacity to see things to the end. Or maybe it's the perfectionist software engineer in me that drives me crazy that is incomplete. Thanks!

thoukydides commented 8 months ago

I have just reported the following to the Home Connect Developer Program team:

The API documentation appears to be quite a few omissions (and a few mistakes) in the API documentation. Here are a few of the things that I have noticed...

Undocumented settings:

  • Refrigeration.Common.Setting.Light.External.Brightness
  • Refrigeration.Common.Setting.Light.External.Power
  • Refrigeration.Common.Setting.Light.Internal.Brightness
  • Refrigeration.Common.Setting.Light.Internal.Power

Undocumented status:

  • Cooking.Oven.Status.CurrentCavityTemperature

Undocumented EVENT:

  • LaundryCare.Dryer.Event.DryingProcessFinished

Undocumented command:

  • BSH.Common.Command.AcknowledgeEvent

Undocumented program keys:

  • BSH.Common.Program.Favorite.
  • ConsumerProducts.CoffeeMaker.Program.Beverage.CaffeGrande
  • ConsumerProducts.CoffeeMaker.Program.CleaningModes.ApplianceOffRinsing
  • ConsumerProducts.CoffeeMaker.Program.CleaningModes.ApplianceOnRinsing
  • Cooking.Hob.Program.FryingSensorMode
  • Cooking.Hob.Program.PowerLevelMode
  • Cooking.Hob.Program.PowerMoveMode
  • Cooking.Oven.Program.Cleaning.Ecolysis
  • Cooking.Oven.Program.Cleaning.Pyrolysis
  • Cooking.Oven.Program.Dish.Automatic.Microwave.Haehnchenteile
  • Cooking.Oven.Program.HeatingMode.GrillLargeArea
  • Cooking.Oven.Program.HeatingMode.HotAirGentle
  • Cooking.Oven.Program.HeatingMode.LetRest
  • Cooking.Oven.Program.Microwave.180Watt
  • Cooking.Oven.Program.Microwave.600Watt
  • Cooking.Oven.Program.SubsequentMode.Microwave
  • LaundryCare.Dryer.Program.ColdRefresh.1Piece
  • LaundryCare.Dryer.Program.ColdRefresh.5Piece
  • LaundryCare.Dryer.Program.ColdRefresh.Business
  • LaundryCare.Dryer.Program.WoolFinish
  • LaundryCare.Washer.Program.HygienePlus
  • LaundryCare.Washer.Program.MyTime
  • LaundryCare.Washer.Program.WashAndDry.60
  • LaundryCare.Washer.Program.WashAndDry.90

Undocumented program options:

  • BSH.Common.Option.BaseProgram
  • BSH.Common.Option.EnergyForecast
  • BSH.Common.Option.ProgramName
  • BSH.Common.Option.WaterForecast
  • ConsumerProducts.CoffeeMaker.Option.AromaSelect
  • ConsumerProducts.CoffeeMaker.Option.Coarsness
  • ConsumerProducts.CoffeeMaker.Option.CoffeeStrength
  • Cooking.Oven.Option.PyrolysisLevel
  • Cooking.Oven.Option.SteamAssistLevel
  • Dishcare.Dishwasher.Option.DelicateBasket
  • Dishcare.Dishwasher.Option.EnergySafe
  • Dishcare.Dishwasher.Option.FlexSpray.BackLeft
  • Dishcare.Dishwasher.Option.FlexSpray.BackRight
  • Dishcare.Dishwasher.Option.FlexSpray.FrontLeft
  • Dishcare.Dishwasher.Option.FlexSpray.FrontRight
  • Dishcare.Dishwasher.Option.FlexSpray.Type
  • Dishcare.Dishwasher.Option.SanitationUC
  • Dishcare.Dishwasher.Option.Turbo
  • Dishcare.Dishwasher.Option.VarioSpeed
  • LaundryCare.Common.Option.LoadRecommendation
  • LaundryCare.Common.Option.ProcessPhase
  • LaundryCare.Common.Option.ReferToProgram
  • LaundryCare.Common.Option.SilentMode
  • LaundryCare.Common.Option.SpeedPerfect
  • LaundryCare.Dryer.Option.ConnectedDry.OriginalProgramTime
  • LaundryCare.Dryer.Option.DryingTargetAdjustment
  • LaundryCare.Dryer.Option.Gentle
  • LaundryCare.Dryer.Option.HalfLoad
  • LaundryCare.Dryer.Option.ProcessPhase
  • LaundryCare.Dryer.Option.WrinkleGuard
  • LaundryCare.Washer.Option.IDos1.Active (incorrectly documented as LaundryCare.Washer.Option.IDos1Active?)
  • LaundryCare.Washer.Option.IDos1DosingLevel
  • LaundryCare.Washer.Option.IDos2.Active (incorrectly documented as LaundryCare.Washer.Option.IDos2Active?)
  • LaundryCare.Washer.Option.IDos2DosingLevel
  • LaundryCare.Washer.Option.IntensivePlus
  • LaundryCare.Washer.Option.LessIroning
  • LaundryCare.Washer.Option.MiniLoad
  • LaundryCare.Washer.Option.Prewash
  • LaundryCare.Washer.Option.ProcessPhase
  • LaundryCare.Washer.Option.RinseHold
  • LaundryCare.Washer.Option.RinsePlus
  • LaundryCare.Washer.Option.RinsePlus1
  • LaundryCare.Washer.Option.SilentWash
  • LaundryCare.Washer.Option.Soak
  • LaundryCare.Washer.Option.SpeedPerfect
  • LaundryCare.Washer.Option.Stains

Undocumented program option values:

  • ConsumerProducts.CoffeeMaker.EnumType.CoffeeTemperature.98C
  • LaundryCare.Washer.EnumType.SpinSpeed.Auto
  • LaundryCare.Washer.EnumType.SpinSpeed.Max
  • LaundryCare.Washer.EnumType.SpinSpeed.RPM700
  • LaundryCare.Washer.EnumType.SpinSpeed.RPM900
  • LaundryCare.Washer.EnumType.SpinSpeed.RPM1500
  • LaundryCare.Washer.EnumType.Temperature.Auto
  • LaundryCare.Washer.EnumType.Temperature.Max
  • Refrigeration.Common.EnumType.Door.States.Open (incorrectly documented as BSH.Common.EnumType.DoorState.Open?)
  • Refrigeration.Common.EnumType.Door.States.Closed (incorrectly documented as BSH.Common.EnumType.DoorState.Closed?)
  • BSH.Common.EnumType.PowerState.MainsOff

It would be helpful if the API documentation could be updated.