[Library Bug] Advanced fields are not parsed properly

[kpustelnik]

Describe the bug
Advanced fields of the services are not being parsed properly.
See eg. built-in action lights > turn_on. It has service.fields such as: transition, rgb_color, effect, color_temp_kelvin, brightness_step_pct, brightness_pct and advanced_fields.

First 6 are formated just like standard fields. The last one (advanced_fields) seems to be some kind of a field group as it contains two items (collapsed [boolean] and fields [list of ServiceFields]). I believe it should be possible to parse such field groups and it is currently not.

Relevant code:

• HomeAssistantAPI/homeassistant_api/models/domains.py

  Line 87 in 50a1104

  class ServiceField(BaseModel):

• HomeAssistantAPI/homeassistant_api/models/domains.py

  Line 62 in 50a1104

  service_id: Service(

[kpustelnik]

Also. It would be really awesome to expose the target of Service.

[GrandMoff100]

Hi! Thank you so much for letting me know about this. Sorry about being so late to this. I've been spending the summer with my family.

I believe you're correct. It does seems like the items under advanced fields are valid "fields" that you can trigger the service with. Although, they're not returning field descriptions and other details that service fields usually come with. I'm going to have to do some more debugging.

Do you know if light is the only service domain that uses advanced_fields? And then, could you clarify what you mean when you say exposing the target of Service?

[kpustelnik]

@GrandMoff100
Hope you had nice holidays!
Yes. Light > turn_on, toggle appears to be the only ones formatted that way.
Ive already managed to create custom models for fetching services. Target is something exposed by the service to specify what can be affected by the automation. Please check the models I had created - it should be more or less clear.
https://github.com/kpustelnik/hass_discord_bot/blob/main/models/ServiceModel.py#L104

[GrandMoff100]

I see. Nice. Ahhhh thats neat, I didn't know the API returned that. It just wasn't returned when at the time I first made the models. I'd love to integrate your models if you're willing to contribute them! They look pretty good, it seems like the easiest way to address this. What do you think?

[kpustelnik]

@GrandMoff100 Of course! Feel free to utilize and adjust them basing on your needs. That's the main reason I linked them ;)

I'm also doing some small modifications to the response from the rest api to parse selectors according to their type. Please see the link to avoid confusion https://github.com/kpustelnik/hass_discord_bot/blob/5a61b8089e40a6339400f86403f23ba0efb46f58/haclient.py#L220

[GrandMoff100]

Would you like to paste your service models in homeassistant_api/models/domains.py and open a pull request so you can get a contribution on the repo? I would feel bad copy-and-pasting it as my own and not giving you appropriate credit in a noticeable way.

[kpustelnik]

@GrandMoff100 Sure! Thanks for asking. I've created the MR. I've pasted most of my model adjustments there that could be implemented into your library. I've done it on web editor though cause I'm in a rush right now (therefore it's not tested even syntax-wise due to lack of IDE) but hopefully it should be alright. Feel free to make any adjustments you'd like or simply let me know.