From 25c6f8fbfcb307bb4345c080f8f81bac1aa54803 Mon Sep 17 00:00:00 2001 From: Christof Wiegand Date: Tue, 17 Dec 2024 15:05:43 +0100 Subject: [PATCH 1/3] Update configuration.md Changed examples according to the example config. Added link to the example config file --- companion/configuration.md | 31 ++++++++++++++++++++----------- 1 file changed, 20 insertions(+), 11 deletions(-) diff --git a/companion/configuration.md b/companion/configuration.md index 3d6c723..03e519d 100644 --- a/companion/configuration.md +++ b/companion/configuration.md @@ -7,6 +7,9 @@ nav_order: 2 # Configuration +## Example Configuration +You can find a working configuration file here: https://github.com/ESPresense/ESPresense-companion/blob/main/src/config.example.yaml + ## GPS Coordinates Find your home's coordinates: - **Google Maps**: Search your address and click the street in front of your house @@ -75,26 +78,32 @@ gps: floors: - id: ground name: Ground Floor - bounds: [left, bottom, z, right, top, z] # Centers your diagram + bounds: [[0, 0, 0], [17.2, 18.5, 2.6]] # Centers your diagram. [[left, bottom, z], [right, top, z]] ``` ### Rooms ```yaml # Paste output from floorplan creator or measure manually -rooms: - - id: living-room - name: Living Room - floor: ground - points: [[0,0], [3,0], [3,4], [0,4]] +# Rooms are members of one floor, so they go aligned to the bounds of their floor +- name: Livingroom + points: + - [6, 12] + - [8.6, 12] + - [8.6, 10] + - [8, 9] + - [6, 9] + - [6, 12] + ``` +Note: you can define 4 or more points depending on the shape of the room. Use clockwise or counter-clockwise order consistently. ### Nodes ```yaml +# Nodes belong to one or more floors, so they are defined as separate yaml node nodes: - - id: esp32-1 - name: Living Room Node - room: living-room - coords: [2,2,1] # x,y,z coordinates within room + - name: Master + point: [3.25, 11, 3.2] + floors: ["first"] ``` Note: Multiple nodes can be mapped to one room, but each needs a unique name. @@ -121,4 +130,4 @@ The configuration file supports hot reloading, which means: - Fine-tune node positions while watching the effects live - No need to restart the companion after changes -## Help write this documentation! Click the edit this page below. \ No newline at end of file +## Help write this documentation! Click the edit this page below. From c9c138b962a51dbcd27fd9bfb1fb844c25c66e41 Mon Sep 17 00:00:00 2001 From: Christof Wiegand Date: Tue, 17 Dec 2024 15:21:44 +0100 Subject: [PATCH 2/3] Update configuration.md Link formated as Markup-Link Units meters added to yaml examples --- companion/configuration.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/companion/configuration.md b/companion/configuration.md index 03e519d..4a4fa98 100644 --- a/companion/configuration.md +++ b/companion/configuration.md @@ -8,7 +8,7 @@ nav_order: 2 # Configuration ## Example Configuration -You can find a working configuration file here: https://github.com/ESPresense/ESPresense-companion/blob/main/src/config.example.yaml +You can find a working configuration file [here](https://github.com/ESPresense/ESPresense-companion/blob/main/src/config.example.yaml) ## GPS Coordinates Find your home's coordinates: @@ -75,6 +75,7 @@ gps: ### Floor Configuration ```yaml +# Units are always meters floors: - id: ground name: Ground Floor @@ -85,6 +86,7 @@ floors: ```yaml # Paste output from floorplan creator or measure manually # Rooms are members of one floor, so they go aligned to the bounds of their floor +# Units are always meters - name: Livingroom points: - [6, 12] @@ -100,6 +102,7 @@ Note: you can define 4 or more points depending on the shape of the room. Use cl ### Nodes ```yaml # Nodes belong to one or more floors, so they are defined as separate yaml node +# Units are always meters nodes: - name: Master point: [3.25, 11, 3.2] From 6f9089dcd3736617fe0f575e3cea9635d61180a7 Mon Sep 17 00:00:00 2001 From: Christof Wiegand Date: Tue, 17 Dec 2024 22:21:43 +0100 Subject: [PATCH 3/3] Update configuration.md Ground floor instead of first floor to keep the examples constant --- companion/configuration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/companion/configuration.md b/companion/configuration.md index 4a4fa98..dc74af3 100644 --- a/companion/configuration.md +++ b/companion/configuration.md @@ -106,7 +106,7 @@ Note: you can define 4 or more points depending on the shape of the room. Use cl nodes: - name: Master point: [3.25, 11, 3.2] - floors: ["first"] + floors: ["ground"] ``` Note: Multiple nodes can be mapped to one room, but each needs a unique name.