@blueharford/scrypted-spatial-awareness 0.4.7 → 0.4.8-beta.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +62 -0
- package/dist/main.nodejs.js +1 -1
- package/dist/main.nodejs.js.map +1 -1
- package/dist/plugin.zip +0 -0
- package/out/main.nodejs.js +554 -137
- package/out/main.nodejs.js.map +1 -1
- package/out/plugin.zip +0 -0
- package/package.json +1 -1
- package/src/core/object-correlator.ts +32 -7
- package/src/core/spatial-reasoning.ts +315 -44
- package/src/core/tracking-engine.ts +57 -19
- package/src/models/alert.ts +41 -14
package/README.md
CHANGED
|
@@ -63,6 +63,68 @@ Done! Your camera topology is configured.
|
|
|
63
63
|
- **MQTT** - Home Assistant integration
|
|
64
64
|
- **REST API** - Query tracked objects programmatically
|
|
65
65
|
|
|
66
|
+
## Topology Configuration
|
|
67
|
+
|
|
68
|
+
The plugin uses topology data (landmarks, zones, connections) to generate meaningful alerts. Camera names are **not** used for location descriptions - only topology landmarks matter.
|
|
69
|
+
|
|
70
|
+
### Setting Up Landmarks
|
|
71
|
+
|
|
72
|
+
For best alert quality, configure landmarks in the topology editor:
|
|
73
|
+
|
|
74
|
+
1. **Entry/Exit Points** - Mark where people enter/exit your property
|
|
75
|
+
- Examples: `Driveway`, `Front Gate`, `Side Gate`, `Street`
|
|
76
|
+
- Set `isEntryPoint: true` or `isExitPoint: true`
|
|
77
|
+
|
|
78
|
+
2. **Access Points** - Paths and walkways
|
|
79
|
+
- Examples: `Front Walkway`, `Back Path`, `Garage Door`
|
|
80
|
+
- Type: `access`
|
|
81
|
+
|
|
82
|
+
3. **Zones** - Areas of your property
|
|
83
|
+
- Examples: `Front Yard`, `Back Yard`, `Side Yard`, `Patio`
|
|
84
|
+
- Type: `zone`
|
|
85
|
+
|
|
86
|
+
4. **Structures** - Buildings and fixed features
|
|
87
|
+
- Examples: `Garage`, `Shed`, `Front Porch`, `Deck`
|
|
88
|
+
- Type: `structure`
|
|
89
|
+
|
|
90
|
+
5. **Features** - Other notable landmarks
|
|
91
|
+
- Examples: `Mailbox`, `Pool`, `Garden`, `Trash Cans`
|
|
92
|
+
- Type: `feature`
|
|
93
|
+
|
|
94
|
+
### Linking Landmarks to Cameras
|
|
95
|
+
|
|
96
|
+
Each camera should have `visibleLandmarks` configured - the landmarks visible in that camera's view:
|
|
97
|
+
|
|
98
|
+
```json
|
|
99
|
+
{
|
|
100
|
+
"cameras": [{
|
|
101
|
+
"deviceId": "abc123",
|
|
102
|
+
"name": "Front Camera",
|
|
103
|
+
"context": {
|
|
104
|
+
"visibleLandmarks": ["front-door", "driveway", "mailbox"]
|
|
105
|
+
}
|
|
106
|
+
}]
|
|
107
|
+
}
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
### Example Topology
|
|
111
|
+
|
|
112
|
+
```json
|
|
113
|
+
{
|
|
114
|
+
"landmarks": [
|
|
115
|
+
{ "id": "driveway", "name": "Driveway", "type": "access", "isEntryPoint": true },
|
|
116
|
+
{ "id": "front-door", "name": "Front Door", "type": "access" },
|
|
117
|
+
{ "id": "backyard", "name": "Back Yard", "type": "zone" },
|
|
118
|
+
{ "id": "garage", "name": "Garage", "type": "structure" }
|
|
119
|
+
]
|
|
120
|
+
}
|
|
121
|
+
```
|
|
122
|
+
|
|
123
|
+
With proper landmarks, alerts become rich and contextual:
|
|
124
|
+
- "Person arrived at the Driveway from Main Street"
|
|
125
|
+
- "Person moved from the Front Porch heading towards the Back Yard"
|
|
126
|
+
- "Person left the Garage towards Driveway after 2m on property - visited Driveway > Front Door > Garage"
|
|
127
|
+
|
|
66
128
|
## Configuration
|
|
67
129
|
|
|
68
130
|
### Settings
|