diff --git a/docs/cards.md b/docs/cards.md deleted file mode 100644 index 22e93fd1..00000000 --- a/docs/cards.md +++ /dev/null @@ -1 +0,0 @@ -# First steps diff --git a/docs/config-overview.md b/docs/config-overview.md new file mode 100644 index 00000000..b5f0d84b --- /dev/null +++ b/docs/config-overview.md @@ -0,0 +1,42 @@ +# Configuration + +To confiure your NSPanel to your needs, you need to edit the `apps.yaml` inside of your Appdaemon config folder and add card and entities you want to display on the screen. + +If you've sucessfully set up mqtt, you should already have a configuration looking like this: + +```yaml +--- +nspanel-1: + module: nspanel-lovelace-ui + class: NsPanelLovelaceUIManager + config: + panelRecvTopic: "tele/tasmota_your_mqtt_topic/RESULT" + panelSendTopic: "cmnd/tasmota_your_mqtt_topic/CustomSend" +``` + +You can continue from this point adding + + +```yaml +--- +nspanel-1: + module: nspanel-lovelace-ui + class: NsPanelLovelaceUIManager + config: + panelRecvTopic: "tele/tasmota_your_mqtt_topic/RESULT" + panelSendTopic: "cmnd/tasmota_your_mqtt_topic/CustomSend" + updateMode: "auto-notify" + locale: "de_DE" + screensaver: + entity: weather.k3ll3r + cards: + - type: cardEntities + entities: + - entity: switch.example_item + name: NameOverride + icon: mdi:lightbulb + - entity: light.example_item + - entity: cover.example_item + - entity: input_boolean.example_item + title: Example Entities 1 +``` \ No newline at end of file diff --git a/docs/overview.md b/docs/index.md similarity index 100% rename from docs/overview.md rename to docs/index.md diff --git a/mkdocs.yml b/mkdocs.yml index 5b160202..0011eed6 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -59,7 +59,7 @@ plugins: - mkdocs-video nav: - - "Overview": overview.md + - "Overview": index.md - "Getting started": - "First steps": - "Prepare NsPanel": prepare_nspanel.md @@ -67,4 +67,4 @@ nav: - "Configure MQTT": configure_mqtt.md - "FAQ": faq.md - "Configuration - apps.yaml": - - "Cards": cards.md \ No newline at end of file + - "Overview": config-overview.md \ No newline at end of file