nlthijs48/home-assistant-crisp

Home Assistant integration for crisp.nl

Home Assistant Crisp

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 using HACS

1. Open the HACS dashboard
2. Add this repository:
   1. Open the menu located in the top-right (the 3 dots)
   2. Select Custom repositories
   3. Repository: enter https://github.com/NLthijs48/home-assistant-crisp
   4. Category: select Integration
   5. Click Add
   6. Close the popup
3. Search for Crisp, or click here:

4. Click the Download button in the bottom right corner
5. Confirm by clicking Download
6. Restart Home Assistant

Set up the integration

1. In the HA UI go to Configuration > Integrations click + and search for Crisp, or click here:

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

Manual installation

Copy all files from custom_component/crisp/ to your HA installation, restart HA, configure the integration

Contributions are welcome!

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

---

home-assistant-crisp's Issues

Implement a reauth flow

Checklist

• I have filled out the template to the best of my ability.
• This only contains 1 feature request (if you have multiple feature requests, open one feature request for each feature request).
• This issue is not a duplicate feature request of previous feature requests.

Is your feature request related to a problem? Please describe.

Whenever the Crisp account is logged out for any reason, you currently need to remove the integration and add it again.

Describe the solution you'd like

Implement the reauth flow so that Home Assistant nicely shows the reauth indication and performs the login flow again (keeping all entities and such).

Describe alternatives you've considered

None

Additional context

https://developers.home-assistant.io/docs/config_entries_config_flow_handler#reauthentication

Store runtime data in config entry

See https://developers.home-assistant.io/blog/2024/04/30/store-runtime-data-inside-config-entry/

Does require bumping minimum HA version first

Support selecting the country of the Crisp account

Crisp is available in BE and NL, support using accounts for both:

1. Ask for the country in the first config flow step
2. Use the country during the login api calls
3. Add the country to the config entry name
   • User accounts at Crisp are specifically for either BE or NL, therefore 2 accounts with the same email can exist, for different countries

Maybe add some device properties that indicate country + userid?

Support translating entity names

Set a translation_key instead of the name field, see https://developers.home-assistant.io/docs/internationalization/core/#name-of-entities