Skip to content

FaceStream.AI

Documentation

Getting started

Getting started

Connect your first camera, add a person and check recognition. Then choose a guide for Home Assistant, Loxone or notifications.

On this page

Your first goal: see a person's name appear on your camera image.

Start FaceStream.AI, connect one camera and add a photo. Once recognition works, connect Home Assistant, Loxone or another system.

What you need

  • A computer or NAS that can run FaceStream.AI. Check the system requirements.
  • A camera with an accessible RTSP or MJPEG stream, and its username and password.
  • One clear photo of a person you want to recognise. You can add more photos later.

Free is enough for your first recognition: one camera, up to three people and one rule with UDP output. Home Assistant via MQTT, the dedicated Loxone connection and push notifications require Pro or higher. See Editions and licence when you are ready to connect another system.

Step 1: Start FaceStream.AI

Choose the instructions for your machine on the Installation page. You only need to follow one installation method.

Already running? Continue below.

Step 2: Choose a password

  1. Open http://<your machine's IP address>:8000 in your browser. For example: http://192.168.1.20:8000.
  2. Choose a password with at least eight characters. There is no preset password.

Use the machine's network IP address rather than localhost. FaceStream uses this address for camera discovery and for image links shared with other systems.

The first page asks you to choose a password for the installation

Step 3: Add your first camera

  1. Open Camera → Search for cameras.
  2. Find your camera and press Set up.
  3. Enter the camera's username and password.
  4. Select a stream. Start with the suggested one.
  5. Press Add camera, then Save cameras.

The camera search has found three cameras in the network 192.168.1.0/24

After signing in, the camera's streams are listed with a snapshot, and one of them is suggested

Camera not listed? Choose Enter an address instead and enter its stream URL. This is also the route for a Loxone Intercom or a camera without ONVIF discovery. The camera guide explains where to find the address.

Step 4: Add the people to recognise

  1. Open People.
  2. Enter the person's name in Add photos for.
  3. Drop a clear photo into the field below it.

Use a sharp, well-lit photo with one person, facing roughly towards the camera. Avoid sunglasses and anything covering the face. FaceStream checks the photo and tells you if it cannot use it.

Adding photos: a name, then the photos dropped onto the field

For better results, add two or three photos with different angles and lighting. See People and photos for examples and details.

Step 5: Watch it recognise

  1. Open Overview.
  2. Walk into the camera's view and wait a few seconds.
  3. Look under Recognition for the person's name. Use Open stream on the camera card to see the face marked in the live image.

The overview with three connected cameras, recognition, notifications and the licence

A recognised person has a green frame and their name. A face without a match is shown in orange as Unknown.

The front door camera marks a recognised girl in green with her name, and her friend in orange as Unknown

Name appearing correctly? Your first setup is complete.

New cameras recognise continuously by default. You do not need a notification rule or a connected automation system for this test. If the result is wrong, check the person's photos first, then see Recognition and requests. That guide also explains the recognition interval, recognition on request and liveness results, including a red frame for a suspected photo or screen presentation.

Next: connect your automation

Choose the system you want to use. FaceStream sends recognition information; your receiving system decides what to do with it.

I want to use… Next step
Home Assistant Follow the Home Assistant guide. Enable discovery in an MQTT connection; no additional FaceStream rule is needed for discovery events. Requires Pro or higher.
Loxone Follow the Loxone guide to send the recognised name to the Miniserver. The dedicated connection requires Pro or higher.
A phone notification Follow Push messages, e-mail and syslog for the connection settings, then add a rule as described below. Push connections require Pro or higher.
UDP, MQTT or a webhook Follow MQTT, webhooks and UDP, then add a rule as described below. UDP is included in Free.

Send a message with a connection and a rule

For notifications and your own event messages, a connection sets the destination and a rule decides when to send. Home Assistant discovery is the exception above.

  1. Open Notifications → Add connection and choose the connection type.
  2. Enter its settings and press Test. This sends a FaceStream test message immediately, before saving. Check the delivery result shown on screen.
  3. Select Add rule. Under When, set Event → Visit starts. With Pro, choose Who → Known people; in Free, the rule reacts to anyone.
  4. Under Then → Add action, select your connection.
  5. Press Save connections and rules, then walk up to the camera again.

For all options, see Connections and rules.

Check what happened

  • Events shows each visit with the person, camera, time, duration and photo. Someone staying at the door is recorded as one visit rather than a new visit for each sighting.
  • Notifications → Recent deliveries shows sent messages and the receiver's response. Check here first if a message does not arrive.

Where to go from here