The input number helper in Home Assistant allows the user to define values that can be controlled via the frontend and can be used within conditions of an automation. The frontend can display a slider or a numeric input box. Changes to the slider or numeric input box generate state events. These state events can be utilized as automation triggers as well.
Spook adds some new actions to the input number integration, which allows you to create and delete input number helpers on the fly, set the value to the minimum or maximum value, and enhances the existing increase and decrease actions by allowing them to increase/decrease the value by a given amount.
Figure 1:Spook adds many new actions to the input number helper integrations.
Devices & entities¶
Spook does not provide any new devices or entities for this integration.
Actions¶
Spook adds the following new actions to your Home Assistant instance:
Create an input number¶
Action properties | |
|---|---|
Input number: Create an input number 👻 | |
| |
No targets | |
Optional, the | |
Newly added action | |
1 2 3 4 5 6 7 8action: input_number.create data: name: "My counter" input_number_id: my_counter min: 0 max: 100 step: 1 mode: slider
Delete an input number¶
Deletes one or more input number helpers made in the UI or with the action above, disabled ones included. Input numbers set up in YAML can only be removed from the YAML.
Everything in the list is checked first: if one of them cannot be deleted, none of them are. Deleting takes an admin, the same as creating one.
Action properties | |
|---|---|
Input number: Delete an input number 👻 | |
| |
No targets | |
No response | |
Newly added action | |
Action data parameters | |||
|---|---|---|---|
Attribute | Type | Required | Default / Example |
| Yes |
|
Decrease value¶
Decrease an input number entity value by a certain amount.
Action properties | |
|---|---|
Input number: Decrease value 👻 | |
| |
Yes, | |
No response | |
Adds an amount to decrement the value with | |
This action already exists but is extended by Spook to add the amount and cycle attributes. If the amount attribute is not provided, the action will use the step value of the input number entity. The amount attribute must be a multiple of the step value. With cycle, going past the end of the range carries on from the other end, the same way selecting the next option cycles a select.
1 2 3 4 5action: input_number.decrement target: entity_id: input_number.my_input_number data: amount: 5
Increase value¶
Increase an input number entity value by a certain amount.
Action properties | |
|---|---|
Input number: Increase value 👻 | |
| |
Yes, | |
No response | |
Adds an amount to increment the value with | |
This action already exists but is extended by Spook to add the amount and cycle attributes. If the amount attribute is not provided, the action will use the step value of the input number entity. The amount attribute must be a multiple of the step value. With cycle, going past the end of the range carries on from the other end, the same way selecting the next option cycles a select.
1 2 3 4 5action: input_number.increment target: entity_id: input_number.my_input_number data: amount: 5
Set value to maximum¶
Set an input number entity to its maximum value.
Action properties | |
|---|---|
Input number: Set maximum value 👻 | |
| |
Yes, | |
No response | |
Newly added action | |
1 2 3action: input_number.max target: entity_id: input_number.my_input_number
Set value to minimum¶
Set an input number entity to its minimum value.
Action properties | |
|---|---|
Input number: Set minimum value 👻 | |
| |
Yes, | |
No response | |
Newly added action | |
1 2 3action: input_number.min target: entity_id: input_number.my_input_number
Set range¶
Changes the minimum, maximum or step of an input number, the same as editing it in the UI.
Action properties | |
|---|---|
Input number: Set range 👻 | |
| |
Yes, | |
No response | |
Newly added action | |
Give at least one of them; what is left out stays as it is. The change is stored, so it survives a restart, like editing the helper does. A value that falls outside the new range is moved inside it. The maximum has to stay above the minimum.
This takes an admin when a user calls it, since it changes how the helper is set up. Automations and scripts are not affected. Only input numbers made in the UI can be changed; one set up in YAML is refused.
A slider that fits a track of whatever length was just loaded:
1 2 3 4 5action: input_number.set_range target: entity_id: input_number.track_position data: max: "{{ states('sensor.track_length_seconds') }}"
Repairs¶
Spook has no repair detections for this integration.
Use cases¶
Some use cases for the enhancements Spook provides for this integration:
Dynamically create input number helpers from a blueprint or script, without requiring the user to set them up manually beforehand.
Clean up temporary input number helpers created by an automation or script when they are no longer needed.
Quickly, with a single action, set the value of an input helper to its maximum or minimum value.
Instead of having to call the
input_number.decrementorinput_number.incrementaction multiple times, you can now set the amount to increase or decrease the value with.
Blueprints & tutorials¶
There are currently no known blueprints or tutorials for the enhancements Spook provides for this integration. If you created one or stumbled upon one, please let us know in our discussion forums.
Feature requests, ideas, and support¶
If you have an idea on how to further enhance this integration, for example, by adding a new action, entity, or repairs detection; feel free to let us know in our discussion forums.
Are you stuck using these new features? Or maybe you’ve run into a bug? Please check the Support page on where to go for help.