Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/contribute/documentation/improve-documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Here’s a quick overview to get you started.

Each pages of the Guide including this one provides a link at its whole bottom:

[Edit this page](hhttps://github.com/NSPManager/NSPanelManager/edit/beta/docs/docs/contribute/documentation/improve-documentation.md)
[Edit this page](https://github.com/NSPManager/NSPanelManager/edit/beta/docs/docs/contribute/documentation/improve-documentation.md)

1. Simply click over this link, it will allow you to edit via GitHub UI directly, the content of the page.
2. Update the content using Markdown in the editor.
Expand Down
8 changes: 8 additions & 0 deletions docs/getting-started/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,5 +53,13 @@ The following is a walkthrough of what to enter:
the beginning and ":8123" (change to your port) at the end.
- **OpenHAB token** - The access token used to authenticate to OpenHAB.

- **Homey (optional)**
- **Homey address** - The IP address or local mDNS name of your Homey instance (e.g., 192.168.1.100 or homey.local)
- **Homey token** - The API key used to authenticate to Homey. To obtain an API key, follow [Homey's API key guide](https://support.homey.app/hc/en-us/articles/8178797067292-Getting-started-with-API-Keys).

:::info
A dedicated Homey Add-on will be available in the future on the Homey App Store.
:::

3. Congrats you have finished the initial setup and you can now use NSPanel Manager.
4. If you are willing to learn more about the Web interface, please read [this](./../web-interface).
49 changes: 48 additions & 1 deletion docs/web-interface.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,9 +124,11 @@ The entities/scenes that are assigned to each slot in the page can also be moved

### Scenes

You can choose to use scenes from Home Assistant or OpenHAB though these scenes will not be able to be saved on the fly.
You can choose to use scenes from Home Assistant, OpenHAB, or Homey though these scenes will not be able to be saved on the fly.
This is something that the NSPanel Manager scenes can perform internally but NSPanel Manager scenes will only manage states of lights.

When using Homey, you can add Flows and Moods as scenes. Homey Flows will appear prefixed with **[F]** and Moods will appear prefixed with **[M]** in the NSPanelManager scenes list.

The NSPanel Manager scenes are easy enough to use. Simply create a scene in the room page and they will be available in
the "Scenes"-list for the room on all NSPanels.

Expand Down Expand Up @@ -228,6 +230,42 @@ An NSPM button entity is controlled by the NSPanel Manager itself. This button e

<CenteredImage src="/images/doc/configure_nspm_button.png" alt="Add/Edit button NSPM" figureNumber="15" />

#### Configure Homey lights

When adding/editing a Homey light entity you get multiple options of characteristics of the light.

- **Homey device <Label value="homey"/>** - The Homey device to control.
- **Name** - The displayed name on the NSPanel and web interface.
- **Type** - is this light a ceiling or table light (as to how it should be grouped/displayed on main page on NSPanel).
- **Control mode** - Is this light dimmable or it it simply an on/off light.
- **Controlled by main page** - If this is marked the light will be included in the displayed data and controlled from the main page of the NSPanel.
This can be uncheck to still have a given light controllable from the panel but not be changed when changing values on the main page.
- **Capabilities** - Can this light handle color temperature and/or color.

<CenteredImage src="/images/doc/select_homey_entity.png" alt="Select Source" figureNumber="16a" />

<CenteredImage src="/images/doc/configure_homey_light.png" alt="Add/Edit light Homey" figureNumber="16b" />

#### Configure Homey switches

When adding/editing a Homey switch entity you simply get to choose the device and the name to use.

- **Homey device <Label value="homey"/>** - The Homey device to control.
- **Name** - The displayed name on the NSPanel and web interface.

<!-- TODO: Add Homey switch configuration screenshot when available -->
<!-- <CenteredImage src="/images/doc/configure_homey_switch.png" alt="Add/Edit switch Homey" figureNumber="16b" /> -->

#### Configure Homey buttons

When adding/editing a Homey button entity you can control devices with on/off capability.

- **Homey device <Label value="homey"/>** - The Homey device with on/off capability.
- **Name** - The displayed name on the NSPanel and web interface.

<!-- TODO: Add Homey button configuration screenshot when available -->
<!-- <CenteredImage src="/images/doc/configure_homey_button.png" alt="Add/Edit button Homey" figureNumber="16c" /> -->

### Switch

It's possible to add relays/switches as controlled entities from the NSPanel. These are simply on/off and can be toggled from the "Entities page" on the NSPanel.
Expand Down Expand Up @@ -361,6 +399,15 @@ The following options are available:
This should include "http://" or "https://" in the beginning and port are the end.
- **Access token** - The access token used to authenticate to OpenHAB.

### Homey API

- **Homey address** - The IP address or local mDNS name of your Homey instance (e.g., 192.168.1.100 or homey.local).
- **Access token** - The API key used to authenticate to Homey. To obtain an API key, follow [Homey's API key guide](https://support.homey.app/hc/en-us/articles/8178797067292-Getting-started-with-API-Keys).

:::info
A dedicated Homey Add-on will be available in the future on the Homey App Store.
:::

## Upload

You may have noticed that there is an "Upload" menu in the top menu bar. Below which there exists items for uploading
Expand Down
Binary file added static/images/doc/configure_homey_light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/images/doc/configure_homey_scene.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/images/doc/select_homey_entity.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/images/doc/select_homey_scene.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.