Skip to content

editorial suggestions in README #1

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

editorial suggestions in README #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
26 changes: 13 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Meraki Camera Notification Example

Leverage Meraki new camera API and MQTT capability to create a notification service. When the camera detects a person consistently appears in a particular zone the service will send a Webex team message to a Webex team room with a video link which will directly go to the video footage when that even occurred. This is useful for alerting unexpected person movement in off-hours.
Leverage Meraki camera API and MQTT capability to create a notification service. When the camera detects a person consistently appears in a particular zone, the service will send a Webex Teams message to a Webex Teams room with a video link which will directly go to the video footage when that event occurred. This is useful for alerting unexpected person movement in off-hours.

![](/docs/digram.png)

Expand All @@ -9,13 +9,13 @@ Leverage Meraki new camera API and MQTT capability to create a notification serv

### API

[Camera API](https://n262.meraki.com/CiscoStore-switc/n/XSQlFbOc/manage/support/api_docs#returns-video-link-for-the-specified-camera): Returns video link for the specified camera. If a timestamp supplied, it links to that time.
[Camera API](https://n262.meraki.com/CiscoStore-switc/n/XSQlFbOc/manage/support/api_docs#returns-video-link-for-the-specified-camera): Returns video link for the specified camera. If a timestamp supplied is, it links to that time.

### MQTT and setting:

1. Go to **Cameras > [Camera Name] > Settings > Sense** page.
2. Click **Add or edit MQTT Brokers > New MQTT Broker** and add you broker information. For testing/trial you can find public broker at [here](https://github.com/mqtt/mqtt.github.io/wiki/public_brokers).
3. You can install [MQTT.fx](https://mqttfx.jensd.de/) to subscribe to MQTT broker. This is a very useful tool
2. Click **Add or edit MQTT Brokers > New MQTT Broker** and add your broker information. For testing/trial, you can find public broker [here](https://github.com/mqtt/mqtt.github.io/wiki/public_brokers).
3. You can install [MQTT.fx](https://mqttfx.jensd.de/) to subscribe to an MQTT broker. This is a very useful tool.



Expand All @@ -29,27 +29,27 @@ General API and MQTT configurations
|---|---|
|MQTT_SERVER|MQTT Broker ip or domain|
|MQTT_PORT|MQTT Broker port|
|MQTT_TOPIC|Meraki Camera mqtt top, default is "/merakimv/#"|
|MERAKI_API_KEY|Meraki Api key|
|NETWORK_ID|Camera's network ID, will use this get video link with camera api|
|COLLECT_CAMERAS_SERIAL_NUMBERS|Array of cameras serial numbers, all is *.|
|COLLECT_ZONE_IDS|Array of zone id, all is *|
|MQTT_TOPIC|Meraki Camera MQTT top, default is "/merakimv/#"|
|MERAKI_API_KEY|Meraki API key|
|NETWORK_ID|Camera's network ID, use this to get video link with camera API|
|COLLECT_CAMERAS_SERIAL_NUMBERS|Array of camera serial numbers, all is *.|
|COLLECT_ZONE_IDS|Array of zone IDs, all is *|

Motion detected configurations, you can keep this as it.
Motion detected configurations, you can keep this as is.

|Name|Description|
|---|---|
|MOTION_ALERT_PEOPLE_COUNT_THRESHOLD| The threshold of people count from the camera to start the detection mode|
|MOTION_ALERT_ITERATE_COUNT| The iterate count when in the detection mode|
|MOTION_ALERT_TRIGGER_PEOPLE_COUNT| After threshold of people count after iteration to trigger the alert or not|
|MOTION_ALERT_TRIGGER_PEOPLE_COUNT| The threshold of people count after which to iteration to trigger the alert|
|MOTION_ALERT_PAUSE_TIME|The pause time after alert is triggered|

#### Configurations in `Webexteam.py`

|Name|Description|
|---|---|
|WEBEXTEAMKEY|The Webex team API key|
|ROOM_ID| The Webex team room ID|
|WEBEXTEAMKEY|The Webex Teams API key|
|ROOM_ID| The Webex Teams room ID|

### Build
1. Run `python3 install -r requirement.txt`
Expand Down