spycle / microbot_push

⛔️ DEPRECATED Home Assistant switch integration to control MicroBot Push
Apache License 2.0
0 stars 0 forks source link
archived deprecated home-assistant microbot-push obselete

This integration is now availiable in core Home Assistant. This repository will no longer be maintained

MicroBot Push

The MicroBot Push integration allows you to control the MicroBot Push.

Prerequisites

In order to use this integration, it is required to have working Bluetooth set up on the device running Home Assistant. A MicroBot Hub is not required for this integration.

If you have multiple MicroBots, you need to know the BTLE MAC address of your device to tell them apart. If the MicroBot is currently paired to the Keymitt or MicroBot app and has not been renamed, the first 4 characters of the BTLE MAC address will be referenced. For example mibp(d206)

Please note, devices cannot remain paired to either app for this integration to function. They will be paired to Home Assistant exclusively.

Before installation the MicroBot Push will need to be in pairing mode. To reset; turn it off and on, wait for the LED to blink red, immediately press and hold the button for about 5 seconds until the LED starts blinking red rapidly, and let go. The LED should now be blinking blue indicating pairing mode.

Installation

Installation is via HACS and then the Home Assistant Integration page. Devices will be automatically discovered.

MicroBot Options

Services

Calibration - set the depth, duration, and switch mode (normal|invert|toggle). The Push will retain the settings locally so only needs running once.

Note: When running this service the MicroBot will push to the given depth to aid in calibration, but not necessarily for the selected duration. The setting is however stored locally on the device.

service: microbot_push.calibrate
data:
  depth: 100
  duration: 10
  mode: 'normal'

Pair/Repair (Generate a token). Required if the MicroBot has been reset.

service: microbot_push.generate_token

Error codes and troubleshooting

The MicroBot integration will automatically discover devices once the Bluetooth integration is enabled and functional.

"No unconfigured devices found": Make sure the Push is powered on and in range. It may be beneficial to wake the device before pairing.

Credits

https://github.com/kahiroka/microbot - the commands required to control the MicroBot

https://github.com/custom-components/integration_blueprint - the blueprint

https://github.com/home-assistant/core/tree/dev/homeassistant/components/switchbot - inspiration, and in some cases more than inspiration