Skip to content

NLthijs48/home-assistant-crisp

Repository files navigation

Home Assistant Crisp

GitHub Release GitHub Activity License

Project Maintenance

Integration to integrate with Crisp.

Crisp account

An instance of this integration provides information about a single Crisp account into Home Assistant. The integration can be set up multiple times if you want to track multiple accounts. An account is represented as a device.

Account sensors

Name Type Description
Order count total int Total number of orders in your Crisp account (includes completed, cancelled and pending orders).
Order count open int Count of open orders in your Crisp account (out for delivery, or planned in the future).

Next order sensors

If there are orders planned for delivery, the following sensors are available for the order that is closest to delivery.

Name Type Description
Next order delivery on date Delivery date
Next order delivery start datetime Start of the delivery window (as selected by the user)
Next order delivery start time time Start time of the delivery window (as selected by the user)
Next order delivery end datetime End of the delivery window (as selected by the user)
Next order delivery end time time End time of the delivery window (as selected by the user)
Next order product count int Number of order lines (count of different products, not a sum of counts)

Installation

  1. Using the tool of choice open the directory (folder) for your HA configuration (where you find configuration.yaml).
  2. If you do not have a custom_components directory (folder) there, you need to create it.
  3. In the custom_components directory (folder) create a new folder called crisp.
  4. Download all the files from the custom_components/crisp/ directory (folder) in this repository.
  5. Place the files you downloaded in the new directory (folder) you created.
  6. Restart Home Assistant
  7. In the HA UI go to "Configuration" -> "Integrations" click "+" and search for "Crisp"

Configuration through the UI

  1. Enter your email address that you use for your Crisp account
  2. Enter the login code you receive on your email from Crisp
  3. Done, entities should show up with information about your account

Contributions are welcome!

If you want to contribute to this please read the Contribution guidelines