Skip to content

Commit 9d75819

Browse files
max-at-groundlightMax McKelveyMax McKelvey
authored
Maxm/add nocode setup tools to docs (#80)
* new pages * fixed docker deployment instructions * removed comment, added purchase links * renamed detector builder page, added prerequisites * formatting * machine must be linux for the docker setup to work * changed docker compose yaml * renamed to notification-server-example and iot example, moved to installation section * changed notification-server-example to Monitoring Notification Server * removed arduino * fixed links * fixed links again * fixed comments * groundlight ai link --------- Co-authored-by: Max McKelvey <[email protected]> Co-authored-by: Max McKelvey <[email protected]>
1 parent 172d24b commit 9d75819

10 files changed

+108
-31
lines changed

docs/docs/installation/6-arduino.md

Lines changed: 0 additions & 24 deletions
This file was deleted.

docs/docs/installation/7-optional-libraries.md renamed to docs/docs/installation/6-optional-libraries.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,11 @@ wrong if you try to use these features.
1111

1212
## PIL - optional but default installed
1313

14-
The `PIL` library offers a bunch of standard utilities for working with images in python. The Groundlight SDK can work without `PIL`.
14+
The `PIL` library offers a bunch of standard utilities for working with images in python. The Groundlight SDK can work without `PIL`.
1515

16-
Because `PIL` is not very large, and is quite useful, we install it by default with the normal build of the Groundlight SDK. So when you
16+
Because `PIL` is not very large, and is quite useful, we install it by default with the normal build of the Groundlight SDK. So when you
1717

18-
``` shell
18+
```shell
1919
pip3 install groundlight
2020
```
2121

@@ -24,8 +24,8 @@ it comes with the `pillow` version of the `PIL` library already installed.
2424
### Working without PIL
2525

2626
If you are extremely space constrained, you can install the Groundlight SDK from source without `PIL` and it will work properly, but with reduced functionality.
27-
Specifically, you will need to convert your images into `JPEG` format yourself. The SDK normally relies on `PIL` to do JPEG compression (which is a non-trivial algorithm), and the API requires images to be in JPEG format. However on space-constrained platforms, sometimes this conversion is done in hardware, and so we don't want to force you to install `PIL` if you don't need it.
27+
Specifically, you will need to convert your images into `JPEG` format yourself. The SDK normally relies on `PIL` to do JPEG compression (which is a non-trivial algorithm), and the API requires images to be in JPEG format. However on space-constrained platforms, sometimes this conversion is done in hardware, and so we don't want to force you to install `PIL` if you don't need it.
2828

2929
## Numpy, OpenCV - fully optional
3030

31-
These commonly-used libraries are not installed by default, because they are quite large, and their installation can often cause conflicts with other dependent libraries. If you want to use them, install them directly.
31+
These commonly-used libraries are not installed by default, because they are quite large, and their installation can often cause conflicts with other dependent libraries. If you want to use them, install them directly.
Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Monitoring Notification Server
2+
3+
This is the easiest way to deploy your Groundlight detectors on a linux computer. All configuration is done through a web user interface, and no code development is required.
4+
5+
## Prerequisites
6+
7+
1. Internet connected linux computer
8+
2. Video source (USB camera or RTSP stream)
9+
3. Groundlight API Key (available from [groundlight.ai](https://www.groundlight.ai/))
10+
11+
## Deployment
12+
13+
1. Install Docker on your computer. See [Docker's installation instructions](https://docs.docker.com/get-docker/).
14+
2. Create a new file called `docker-compose.yml` in your project directory. Copy the following into it:
15+
16+
```yaml
17+
services:
18+
frontend:
19+
image: docker.io/groundlight/monitoring-notification-server-frontend:latest
20+
ports:
21+
- "3000:3000"
22+
depends_on:
23+
- backend
24+
backend:
25+
image: docker.io/groundlight/monitoring-notification-server-backend:latest
26+
ports:
27+
- "8000:8000"
28+
devices:
29+
- /dev/video0:/dev/video0
30+
- /dev/video1:/dev/video1
31+
- /dev/video2:/dev/video2
32+
- /dev/video3:/dev/video3
33+
privileged: true
34+
volumes:
35+
- /dev/bus/usb:/dev/bus/usb
36+
```
37+
38+
3. Run the following command in your project directory:
39+
40+
```bash
41+
docker-compose up
42+
```
43+
44+
4. If installed locally, open http://localhost:3000 in your browser. If installed on a remote device, replace `localhost` with the IP address of your device. You should see the following page:
45+
46+
![Screenshot of the Groundlight Monitoring Notification Server](/img/docker-img-frontpage.png)
Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# No-Code IoT Deployment
2+
3+
Groundlight supplies a tool for no-code deployment of a detector to an ESP32 Camera board. You can find it at https://code.groundlight.ai/groundlight-embedded-uploader/.
4+
5+
## Easy Deployment
6+
7+
This tool is designed to make it as easy as possible to deploy your Groundlight detector on an ESP32 Camera Board. You can deploy your detector in just a few clicks.
8+
9+
1. Go to https://code.groundlight.ai/groundlight-embedded-uploader/.
10+
2. Plug your ESP32 Camera Board into your computer with a USB cable.
11+
3. Click through the steps to upload your detector to your ESP32 Camera Board.
12+
13+
## Notification Options
14+
15+
The tool supports the following notification options for your deployed detector:
16+
17+
- Email
18+
- SMS (With Twilio)
19+
- Slack
20+
21+
## Multiple Supported Boards
22+
23+
Tested with the following boards. Many other ESP32 boards should work as well, but may require building the firmware from source and changing the IO pin definitions.
24+
25+
- M5Stack ESP32 PSRAM Timer Camera [[purchase here](https://shop.m5stack.com/products/esp32-psram-timer-camera-ov3660)]
26+
- M5Stack ESP32 PSRAM Timer Camera X [[purchase here](https://shop.m5stack.com/products/esp32-psram-timer-camera-x-ov3660)]
27+
- ESP32-CAM [[purchase here](https://www.amazon.com/s?k=ESP32-CAM&i=electronics)]
28+
- SeeedStudio ESP32S3 Sense [[purchase here](https://www.seeedstudio.com/XIAO-ESP32S3-Sense-p-5639.html)]
29+
30+
<img
31+
src={require('/img/m5stack_timer_camera.png').default}
32+
alt="Example banner"
33+
width={"25%"}
34+
/>
35+
<img
36+
src={require('/img/m5stack_timer_camera_x.png').default}
37+
alt="Example banner"
38+
width={"25%"}
39+
/>
40+
<img
41+
src={require('/img/esp32-cam.png').default}
42+
alt="Example banner"
43+
width={"25%"}
44+
/>
45+
<img
46+
src={require('/img/xiao-esp32s3-sense.png').default}
47+
alt="Example banner"
48+
width={"25%"}
49+
/>
50+
51+
## Source Code
52+
53+
The source code is written as an Arduino-based PlatformIO project for ESP32, and is available on GitHub at https://github.com/groundlight/esp32cam
54+
55+
If you need assistance or have questions about integrating Groundlight with Arduino, please consider opening an issue on the GitHub repository or reaching out to our [support team](mailto:[email protected]).

docs/docs/installation/installation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Choose your platform from the list below and follow the instructions in the corr
1111
- [Windows](3-windows.md)
1212
- [Raspberry Pi](4-raspberry-pi.md)
1313
- [NVIDIA Jetson](5-nvidia-jetson.md)
14-
- [Arduino](6-arduino.md)
14+
- [Linux with Monitoring Notification Server](7-monitoring-notification-server.md)
15+
- [ESP32 Camera Device](8-nocode-iot-deployment.md)
1516

1617
After completing the installation process for your platform, you'll be ready to start [building visual applications](/docs/building-applications/) using the Groundlight SDK.
17-
1.13 MB
Loading

docs/static/img/esp32-cam.png

1.43 MB
Loading
224 KB
Loading
178 KB
Loading
653 KB
Loading

0 commit comments

Comments
 (0)