Calibrate

Use this action to calibrate a MicroBot Push. You set how far the push arm extends, how long it stays extended, and the mode it operates in. The settings are stored on the device, so they apply to later presses as well.

Using this action from the user interface

If you prefer building automations and scripts visually, Home Assistant walks you through this action step by step. You pick what to target, tweak a few options, and save. No YAML knowledge required.

To calibrate a MicroBot Push from an automation or a script:

1. Go to Settings > Automations & scenes.
2. Open an existing automation or script, or select Create automation > Create new automation.
3. If you’re setting up a new automation, add a trigger in the When section. Scripts don’t need a trigger. They run when something else calls them.
4. In the Then do section, select Add action.
5. From the search box, search for and select Keymitt MicroBot Push: Calibrate.
6. In Entity, select the MicroBot Push switch you want to calibrate.
7. Set the Depth, Duration, and Mode.
8. Select Save.

Options in the UI

Using this action in YAML

If you work directly in YAML, or you want to know exactly what Home Assistant does under the hood, this section has the technical reference. It lists the field names you use in YAML, their types, and which ones are required. For how an automation or a script is built in YAML, refer to Automations in YAML and Scripts.

In YAML, refer to this action as keymitt_ble.calibrate. A basic example looks like this:

action: keymitt_ble.calibrate
target:
  entity_id: switch.microbot_push
data:
  depth: 50
  duration: 1
  mode: normal

This calibrates the switch.microbot_push entity to extend the arm halfway, hold for one second, and operate in normal mode.

Options in YAML

Targets of the action

This action requires a target. The target is the object of the action. You can point the action at a single entityAn entity represents a sensor, actor, or function in Home Assistant. Entities are used to monitor physical properties or to control other entities. An entity is usually part of a device or a service. [Learn more], a device, an area, a floor, or a label, and Home Assistant will run the action on every matching MicroBot Push switch behind that target.

• Entity: one specific MicroBot Push switch, such as switch.living_room.
• Device: every MicroBot Push switch that belongs to a device.
• Area: every MicroBot Push switch in a room or area.
• Floor: every MicroBot Push switch on a floor.
• Label: every MicroBot Push switch that shares a label.

You can also select different target types in one action. For example, you can add a specific entity and an area as targets in the same action to run the action on both of them at once.

In the UI, this action has an Entity field instead of targets. There, you can select one MicroBot Push switch. To use a device, an area, a floor, or a label as the target, select the three dots menu on the action, and then select Edit in YAML.

Good to know

• After the action runs, the push arm extends or retracts depending on the mode you set. The mode and depth are demonstrated right away, but the duration is not. The setting is still stored and can be confirmed by manually operating the device.

Try it yourself

Ready to test this? Open Settings > Tools > Actions, search for this action, fill in the fields, and select Perform action. You see what happens on your actual entitiesAn entity represents a sensor, actor, or function in Home Assistant. Entities are used to monitor physical properties or to control other entities. An entity is usually part of a device or a service. [Learn more] without writing a line of YAML.

Still stuck?

To test the action on its own, run it in the automation editor with Run action, and check the message that it shows. To see what the action did when the automation ran, open the trace of that run. For details, refer to Testing automations. For common problems and their solutions, refer to Troubleshooting automations.

If that doesn’t help, the Home Assistant community is quick to help: join Discord for real-time chat, post on the community forum with the action you’re calling and what you expected to happen, or share on our subreddit /r/homeassistant.