Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update configuration.md #179

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
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
34 changes: 23 additions & 11 deletions companion/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -72,29 +75,38 @@ gps:

### Floor Configuration
```yaml
# Units are always meters
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
# Units are always meters
- 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
# Units are always meters
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: ["ground"]
```
Note: Multiple nodes can be mapped to one room, but each needs a unique name.

Expand All @@ -121,4 +133,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.
## Help write this documentation! Click the edit this page below.