Skip to content

crownstone/crownstone-homey

Repository files navigation

Homey Crownstone App

A Crownstone app that integrates with the Homey smart home hub. Here you can find a step-by-step tutorial to get started with the app.

Spheres

The Homey does not have a concept of multiple homes. This is quite logical, because it is likely to be placed in one physical location. Crownstones however are a network of devices that you can install in your own home, but also in your garage, your holiday home, at your grandmother's, etc. In the Crownstone system a physical collection of Crownstone is represented by the concept sphere.

When installig the Crownstone app you will get access to all the spheres you have access to. This has three reasons:

  1. This is how it is done for Home Assistant, Alexa, Google Home, and all other smart home hubs.
  2. If it is possible to remotely control other spheres we want to enable that for the user. This is not possible yet, though!
  3. We do not want to bother people with selecting particular spheres.

Let's go in detail now.

Homey app

You need the Homey app to install the Crownstone software from the Homey app store.

User overview in the Homey app

You can install the app like you normally would do for other apps on the Homey as well. Go to "Apps" and click the "+" sign at the top right corner. In the end you will have the app installed.

Homey app store Search the app store Have the Crownstone app installed

There is no need to configure the app, press the top left arrow to go back to the menu if you see the below screen.

No need to configure the app

Adding devices

For adding devices you click the second icon at the bottom.

Add devices

Now click on the + in the top right corner or on the Add my first device text in the middle (if it is your first device). You will have to select Crownstone and click through a few times.

Add devices and select Crownstone Add devices and select Crownstone Add devices and select Crownstone

When adding devices for the first time, you'll be asked to log in to your Crownstone account. It will retrieve information about your Crownstone devices from the cloud.

Login to the Crownstone servers

Enter your credentials and select the Crownstone devices you want to add.

List of Crownstone devices to choose from Devices to be added, can take a while

Now you will have a list of devices, all in the Home zone:

Device overview

Using devices

If you click a device you directly control it. You can also long-press an icon, for example to dim it.

Dim device

There are a few settings you can change per device. For example the zone and what's plugged in to it.

Change device settings Choose a zone Select what is plugged into the socket

Crownstone can be locked. Those Crownstone cannot be controlled from the Homey. If you want to control such a Crownstone you will see a message like this.

Locked message

The result can be compared with the Crownstone app:

Locked message Locked message

Flows

You can also create flows within the Homey. This works like follows.

Create a flow Create a flow Create a flow Create a flow Create a flow

Using flows you can have all kind of actions coupled to events such as that someone enters a room or leaves the house.

Developer settings

You can select if the Crownstone should be switched using the Crownstone cloud or using Bluetooth LE. The latter is an experimental setting and should not be used yet. By default only the cloud is used.

License

Open-source license

This software is provided under a noncontagious open-source license towards the open-source community. It's available under three open-source licenses:

  • License: LGPL v3+, Apache, MIT

License: LGPL v3 License: MIT License: Apache 2.0

Commercial license

This software can also be provided under a commercial license. If you are not an open-source developer or are not planning to release adaptations to the code under one or multiple of the mentioned licenses, contact us to obtain a commercial license.

  • License: Crownstone commercial license

Contact

For any question contact us at https://crownstone.rocks/contact/ or on our discord server through https://crownstone.rocks/forum/.