{"id":22352078,"url":"https://github.com/bertreb/pimatic-home-connect","last_synced_at":"2025-03-26T12:10:43.775Z","repository":{"id":57141830,"uuid":"242779630","full_name":"bertreb/pimatic-home-connect","owner":"bertreb","description":"Pimatic plugin for connecting home-connect devices to Pimatic","archived":false,"fork":false,"pushed_at":"2020-04-14T19:18:40.000Z","size":262,"stargazers_count":1,"open_issues_count":2,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-18T11:35:42.511Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"CoffeeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bertreb.png","metadata":{"files":{"readme":"README.md","changelog":"HISTORY.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-02-24T16:02:33.000Z","updated_at":"2020-04-14T19:18:43.000Z","dependencies_parsed_at":"2022-09-03T06:53:06.473Z","dependency_job_id":null,"html_url":"https://github.com/bertreb/pimatic-home-connect","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bertreb%2Fpimatic-home-connect","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bertreb%2Fpimatic-home-connect/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bertreb%2Fpimatic-home-connect/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bertreb%2Fpimatic-home-connect/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bertreb","download_url":"https://codeload.github.com/bertreb/pimatic-home-connect/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245650496,"owners_count":20650105,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-04T12:17:04.266Z","updated_at":"2025-03-26T12:10:43.747Z","avatar_url":"https://github.com/bertreb.png","language":"CoffeeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# pimatic-home-connect\nPimatic plugin for connecting Home-Connect devices to Pimatic\n\n# Installation\n\n### HOME-CONNECT\nCreate an application in your account on the [developers site of Home-connect](https://developer.home-connect.com).\nFor the simulator usage Authorisation Code Grant Flow as authorisation type and  http://localhost:3000/o2c as redirect uri. The ClientId and ClientSecret of this application must be used as clientIdSim and clientSecretSim in the plugin.\nFor live usage create another application and use Device Flow as authorisation type. The ClientId and ClientSecret of this application must be used as clientId and clientSecret in the plugin.\n\n### PIMATIC\n1. install the plugin via the plugins page\n2. add your credentials; clientId and clientSecret (for live) and clientIdSim and clientSecretSim (for simulator)\n3. set the plugin in simulator or live (simulator = false)\n4. restart Pimatic\n5. create a HomeconnectManager device\n6. start discovery and add discovered devices\n\nThe devices CoffeeMaker, Washer, DishWasher, Oven, Dryer, FridgeFreezer, Hood and CleaningRobot are implemented. In simulator mode the approval of the Home-Connect access rights is handled by the plugin. No popup screen!\nIn Live mode the approval is done via the gui. In the HomeconnectManager device the link in the label is used for the authentication uri.\n\nDevices must be added via the device discovery.\nAll devices are of the HomeconnectDevice class.\n\nSwitching from Simulator mode to Live mode is done in the plugin config. After that a restart is required. Simulator devices are offline in Live mode and Live devices are offline in Simulator mode.\n\n## Actions\nActions can be executed via rules. The rule syntax is\n```\nhomeconnect \u003cdevice id or name\u003e [start, startopts $\u003cprogramOptionsVariable\u003e, pause, resume, stop]\n```\nWhether an action is available, is depending on the device capabilities and the allowed control scope.\n\nThe format for the $\\\u003cprogramOptionsVariable\\\u003e is:\n```\nprogram: \u003cprogramId\u003e, \u003coptionName\u003e: \u003coptionValue\u003e, \u003coptionName\u003e: \u003coptionValue\u003e, ...\n```\n\nExample for CoffeeMaker\n\n```\nhomeconnect \u003cCoffeeMakerId\u003e startopts $options\n```\nValue of the variable $options is\n```\nprogram: Cappuccino, BeanAmount: DoubleShot, CoffeeTemperature: 95C, FillQuantity: 100\n```\nThe used syntax for the program name, option name and option value must be exactly as defined in the api documentation. See the Programs and options for syntax definitions. For an example see the CoffeeMaker [API-DOCS](https://developer.home-connect.com/docs/coffee-maker/supported_programs_and_options). For the name part after the last dot is used for the value its also the part after the last dots (in case of enum) or the value itself. If a program or option parameter is not used in the option variable, the current setting for that parameter is used.\n\nFor the interface with the Home-Connect api the homeconnect_api.js is used. This lib is written by Alexander Thoukydides.\n\n# Programs and options\nThe following program and options settings are the maximum available for a device. A specific type / brand of a device will probably use a subset of these values. See your device manual to check what is available for your device.\n### Coffeemaker\n___Programs___: Espresso, EspressoMacchiato, Coffee, Cappuccino, LatteMacchiato, CaffeLatte, Americano, EspressoDoppio, FlatWhite, Galao, MilkFroth, WarmMilk, Ristretto, Cortado, KleinerBrauner, GrosserBrauner, Verlaengerter, VerlaengerterBraun, WienerMelange, FlatWhite, Cortado, CafeCortado, CafeConLeche, CafeAuLait, Doppio, Kaapi, KoffieVerkeerd, Galao, Garoto, Americano, RedEye, BlackEye, DeadEye\n\n___BeanAmount___: VeryMild, Mild, MildPlus, Normal, NormalPlus, Strong, StrongPlus, VeryStrong, VeryStrongPlus, ExtraStrong, DoubleShot, DoubleShotPlus, DoubleShotPlusPlus, CoffeeGround\n\n___CoffeeTemperature___: 88C, 90C, 92C, 94C, 95C, 96C\n\n___FillQuantity___: 60 - 260 with stepsize 20\n\n### Washer\n___Programs___: Cotton, EasyCare, Mix, DelicatesSilk, Wool, Sensitive, Auto30, Auto40, Auto60, Chiffon, Curtains, DarkWash, Dessous, Monsoon, Outdoor, PlushToy, ShirtsBlouses, Outdoor, SportFitness, Towels, WaterProof\n\n___Temperature___: Cold, GC20, GC30, GC40, GC50, GC60, GC70, GC80, GC90\n\n___Spinspeed___: RPM400, RPM600, RPM800, RPM1000, RPM1200, RPM1400\n\n### DishWasher\n___Programs___: Auto1, Auto2, Auto3, Eco50, Quick45, Intensiv70, Normal65, Glas40, GlassCare, NightWash, Quick65, Normal45, Intensiv45, AutoHalfLoad, IntensivPower, MagicDaily, Super60, Kurz60, ExpressSparkle65, MachineCare, SteamFresh, MaximumCleaning\n\n___StartInRelative___: 1 - 86340 (in seconds)\n\n### Oven\n___Programs___: PreHeating, HotAir, TopBottomHeating, PizzaSetting, HotAirEco, HotAirGrilling, TopBottomHeatingEco, BottomHeating, SlowCook, IntensiveHeat, KeepWarm, PreheatOvenware, FrozenHeatupSpecial, Desiccation, Defrost, Proof\n\n___SetpointTemperature___: 30 - 275 (in °C)\n\n___Duration___: 1 - 86340 (in seconds)\n\n___FastPreHeat___: false or true\n\n___StartInRelative___: 1 - 86340 (in seconds)\n\n### Dryer\n___Programs___: Cotton, Synthetic, Mix, Blankets, BusinessShirts, DownFeathers, Hygiene, Program.Jeans, Outdoor, SyntheticRefresh, Towels, Delicates, Super40, Shirts15, Pillow, AntiShrink\n\n___DryingTarget___: IronDry, CupboardDry, CupboardDryPlus\n\n### FridgeFreezer\n___Programs___: none\n\n___SetpointTemperatureRefrigerator___: 2 to 8 (in °C)\n\n___SetpointTemperatureFreezer___: -24 to -16 (in °C)\n\n___SuperModeRefrigerator___: false or true\n\n___SuperModeFreezer___: false or true\n\n___EcoMode___: false or true\n\n### Hood\n___Programs___: Automatic, Venting, DelayedShutOff\n\n___VentingLevel___: FanOff, FanStage01, FanStage02, FanStage03, FanStage04, FanStage05\n\n___IntensiveLevel___: IntensiveStageOff, IntensiveStage1, IntensiveStage2\n\n### CleaningRobot\n___Programs___: CleanAll, CleanMap, GoHome\n\n___CleaningMode___: Silent, Standard, Power\n\n___ReferenceMapID___: TempMap, Map1, Map2, Map3, Map4, Map5\n\n\n---\n__The minimum requirement for this plugin is node v8!__\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbertreb%2Fpimatic-home-connect","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbertreb%2Fpimatic-home-connect","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbertreb%2Fpimatic-home-connect/lists"}