Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ability to specify event icon when creating event with HTTP API #12505

Open
sebastian-bartkowiak opened this issue Jul 18, 2024 · 8 comments
Open
Labels
enhancement New feature or request pinned

Comments

@sebastian-bartkowiak
Copy link

Describe what you are trying to accomplish and why in non technical terms
I want to be able to specify event icon when creating event programatically (with HTTP API) so that I can distinguish events easily when reviewing them.

Describe the solution you'd like
I belive simple extension of body POSTed at /api/events/<camera_name>/<label>/create with field like icon would do the trick. That would leave two other things - listing available icons somewhere in the docs for the user to choose from and handling case when user wishes to use unrecognised icon. For the latter I belive a simple fallback to default icon would be acceptable.

Describe alternatives you've considered
I don't really see any alternative.

Additional context
I'm programatically creating events for multiple things occuring around the house so that I can later easily check them. Since we have event icons in new GUI version it would be cool if I could leverage that :)

@sebastian-bartkowiak sebastian-bartkowiak added the enhancement New feature or request label Jul 18, 2024
@sebastian-bartkowiak
Copy link
Author

By the way - I noticed minor inconsistency. Event icon is not presented on events listed on top bar of "live" screen, when most recent events are presented.

@NickM-27
Copy link
Collaborator

this is on purpose, the filmstrip at the top is too small to show the icons because it would cover a large portion of the image

@sebastian-bartkowiak
Copy link
Author

OK, I think that small icon wouldn't cover that much of the image, but that's not crutial for me.
What do you think about the core of my enhancement idea?

@NickM-27
Copy link
Collaborator

OK, I think that small icon wouldn't cover that much of the image, but that's not crutial for me.

It really does, see this example of a filmstrip item with and without the icons. It covers the white pickup that parked on the street and created the event

Screen Shot 2024-07-18 at 14 35 15 PM

Screen Shot 2024-07-18 at 14 37 23 PM

What do you think about the core of my enhancement idea?

It would be pretty complicated the way it is described, we do not interface with the events in the UI, it is the review items. So the icon sent to the api, store it as an event, and then store that in reviews but make it clear which item it applies to while we would not want to affect the non custom icons.

An alternative would be allowing a configuration to create a custom map of custom labels to Fa icons (kind of like how the camera groups works).

@sebastian-bartkowiak
Copy link
Author

An alternative would be allowing a configuration to create a custom map of custom labels to Fa icons (kind of like how the camera groups works).

That sounds fine by me - I belive that would additionally allow to change default icon for an event - you could just specify icon for label "person" to be whatever you want it to be :)

@NickM-27
Copy link
Collaborator

you could just specify icon for label "person" to be whatever you want it to be :)

right, but that is something we probably don't want, which is where in general stuff like this gets complicated. In general we try to avoid lots of small little options to change small things in the UI because it is more work to maintain, creates more opportunities for bugs, more things to document and keep up to date, etc.

@sebastian-bartkowiak
Copy link
Author

Yea, I get it, but with #12506 closed this enhancement idea is the only way I see to keep API created events usable. Otherwise all of them have the same icon, and checking their name is not easy (on computer) or not doable at all (on mobile).

@NickM-27
Copy link
Collaborator

right, I think it will be easier as custom events are used more in the new UI and we can understand what people are using them for and what the best way for the UI to communicate that is

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request pinned
Projects
None yet
Development

No branches or pull requests

2 participants