-
Notifications
You must be signed in to change notification settings - Fork 26
Feature Request: Stable IDs for profiles #40
Please introduce stable identifiers or aliases to Profiles. (doc/Profiles.md states any modification to a profile could break external references to it, making the experience brittle. That sounds like maybe the only stably referenced profiles would be the built in ones without modification. If I've missed something let me know. )
Use case: Siri and Shortcuts.
I use Siri with my Decent now via MQTT (personal app) and plan to order the USBC board. The Shortcuts app allows a user to prefill an entity and give the command a custom name, eg say "Siri, ex dos" instead of "Siri, set decent profile to ex dos". The App Intents framework backing that interaction will store off a unique identifier for the Ex Dos profile entity that existed at the time the user made the shortcut. If this identifier 404s, their shortcut breaks.
Ideally, the ID should be conceptually what a user sees as an entity. Explicitly forking it should change the ID, but "fixing" its description or some minor value would be an unexpected break.
All reactions
Replies: 2 comments
hey @importRyan ! Thanks for sharing your opinion.
After reading your request, I see two things that stand out.
First one - about editing profiles. There is no mention of editing profiles in the Profiles.md document. Please tell me if you saw it somewhere else.
The new proposed principle of "editing" is more like an evolution of a profile. When you want to save a new version of the profile, you reference its parent - the profile "id" your new changes are based on:
curl -X POST http://localhost:8080/api/v1/profiles \
-H "Content-Type: application/json" \
-d '{
"profile": {...},
"parentId": "profile:a3f2c8b4d1e6f9a2"
}'
this will allow us to follow the evolution of profiles and hopefully better attribute actual authors of profiles eventually.
The second part is the - unfortunately not yet well documented - profile selection. You probably want to select a "workflow". I think it's similar to Damian's DSx favorites.
I have a similar setup on my watch too. But I just use shortcuts and json payload. saying "Siri, nice soup profile" sets my machine up for brewing with a specific profile, specific input dose, output target, steam, flush and hot water settings. Oh and beans info too.
NOTE: workflow api in the sense of CRUD does not exist yet, we also need to create a feature request for it, for tracking.
All reactions
@importRyan let me know if using the workflow api works for you or if there's anything else we can discuss.
Best,
Vid