Skip to content

Commit

Permalink
quickstart
Browse files Browse the repository at this point in the history
  • Loading branch information
dcmartin committed Oct 29, 2020
1 parent 8286c73 commit 56b6a6b
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 7 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Motion Ã👁
An open-source software solution for situational awareness from a network of video and audio sources. Utilizing [Home Assistant](http://home-assistant.io), [addons](http://github.com/motion-ai/addons), the LINUX Foundation [Open Horizon](http://github.com/open-horizon) edge fabric, and [edge AI services](https://github.com/motion-ai/open-horizon), the system enables _personal_ AI on low-cost devices (e.g. RaspberryPi); integrating object detection and classification into a dashboard of daily activity.

+ Use this [guide](docs/QUICKSTART.md) to get started.
+ Use the QuickStart (see below) or review this [guide](docs/QUICKSTART.md).
+ Visit us on the [Web](http://www.motion-ai.com)
+ Find us on [Facebook](https://www.facebook.com/groups/motionai/)
+ Connect with us on [LinkedIn](https://www.linkedin.com/company/motion-%C3%A3i)
Expand Down
15 changes: 9 additions & 6 deletions docs/QUICKSTART.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,21 @@ This _quick start_ is suitable for the following:
## Step 1 - Install
There are two scripts used for installation:

+ [`get.hassio.sh`](https://raw.githubusercontent.com/dcmartin/motion-ai/master/sh/get.hassio.sh) - Update, upgrade, and install all packages required
+ [`get.motion-ai.sh`](https://raw.githubusercontent.com/dcmartin/motion-ai/master/sh/get.hassio.sh) - Update, upgrade, and install all packages required
+ [`hassio-install.sh`](https://raw.githubusercontent.com/dcmartin/motion-ai/master/sh/hassio-install.sh) - Download and start Home-Assistant supervisor and friends

The `get.hassio.sh` script is idempotent, so it can be run again without issue. The script will automatically call `hassio-install.sh` (n.b. also idempotent) providing the
appropriate _machine_ and using the current working directory.
The `get.motion-ai.sh` script is idempotent, so it can be run again without issue. The script will automatically call `hassio-install.sh` (n.b. also idempotent) providing the appropriate _machine_ and using the current working directory.

```
sudo apt update -qq -y
sudo apt install -qq -y git curl jq
sudo apt install -qq -y make git curl jq ssh
git clone http://github.com/dcmartin/motion-ai
cd motion-ai
sudo ./sh/get.hassio.sh
cp webcams.json.tmpl webcams.json
nano config.sh # edit!
sudo ./sh/get.motion-ai.sh
bash -x config.sh
make
reboot
```

Expand All @@ -29,7 +32,7 @@ The configuration of the system is controlled by the `webcams.json` file in the
~/motion-ai/webcams.json
```

A default [template](https://raw.githubusercontent.com/dcmartin/motion-ai/master/homeassistant/motion/webcams.json.tmpl) is provided and should be copied to create the file.
A default [template](https://raw.githubusercontent.com/dcmartin/motion-ai/master/webcams.json.tmpl) is provided and should be copied to create the file.
[Options](OPTIONS.md) may be specified through environment variables and/or local files with the same name. Whenever the `webcams.json` file or the _options_ have changed, run `make restart` in the top-level directory to rebuild and restart, for example:

```
Expand Down

0 comments on commit 56b6a6b

Please sign in to comment.