Lumas

Lumas provides intelligence to off-the-shelf IP cameras. It's goal is to make it possible for anyone to solve problems with computer vision without requiring computer vision experience or even a software development background.

Lumas will be able to manage the camera connections, video storage, feed processing, event handling, and actions. For example, Lumas can connect to any IP camera, process the feed for motion, classify any moving objects (person, animal, car, etc.), and take action if a condition is met (e.g. a person is detected on premises after dark).

This is the Lumas core services. These services are

• stream processor
• client (lumasctl)
• API protobufs

Future services:

• session server
• event service

Setup

Requirements

Software Requirements:

• Docker (CE or EE)

Hardware Requirements:

• Architecture: x86_64

Quick Start

Run the Lumas server

1. Copy the docker-compose.yml file from this repo to the Lumas server
2. Run with docker-compose up

Now you will have a Lumas server ready to receieve a configuration for ONVIF compatible cameras. It will process the RTSP stream and watch for motion as well as save the camera feed to a file in the "video" Docker volume. The Docker volume is created automatically if it does not already exist.

Create a configuration

1. On your workstation, download the lumasctl binary for your platform
2. Create a config.yml file. There's an example config.yml in this repository
3. Apply the configuration with ./lumasctl apply --controller <ADDRESS OF THE LUMAS SERVER>:5389 config.yml
4. Ensure sure your cameras were applied with ./lumasctl --controller <ADDRESS OF THE LUMAS SERVER>:5389> camera list

Client config file

In order to not have to specify the address of the controller each time, you can create a client configuration file at ~/.lumasctl.cfg. It is a yaml format and accepts the controller parameter

For example:

---
controller: "192.168.2.207:5389"

The basic configuration file structure looks like this:

---
cameras:
  - name: "Camera Name"
    provider:
      name: <camera provider extension>
      config:
        <provider parameters>

Cameras parameters

The cameras section of the configuration is a list of cameras. Currently Lumas ony supports one camera at a time. Multi-camera support will be added soon.

Also, currently only ONVIF cameras are support. Other camera support will be added soon.

Example:

---
cameras:
  - name: "<Camera Name>"
    plugin:
      name: onvif
      config:
        rtspAddress: "rtsp://<username>:<password>@<camera address>"

Development

1. Create a directory called lumas
2. Clone this repo to the lumas directory
3. Clone the ONVIF provider extension into the lumas directory
4. Copy the docker-compose.dev.yml file from this repo to the lumas directory
5. Run with docker-compose -f docker-compose.dev.yml up. Note, make sure you stop any Lumas servers you already had running.

Any time you modify files in the git clones, you can restart the Lumas server with the new code using the following command: DC=docker-compose.dev.yml docker-compose -f $DC down && docker-compose -f $DC up

Roadmap

• More camera vendor support: Amcrest, Foscam, etc.
• Event system with easily configured responses
• Face recognition - Learn familiar faces over time with custom alerts
• Time lapse - See what's been happening through the day