Skip to content

Releases: roflcoopter/viseron

v3.0.0b2 - Fix playback and running as root

08 Apr 08:43
@roflcoopter roflcoopter
v3.0.0b2
b2007ab
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Learn about vigilant mode.
Compare
Choose a tag to compare
v3.0.0b2 - Fix playback and running as root Pre-release
Pre-release

Various fixes for the v3.0.0b1 release

Fixes:

  • Make sure thumbnails are lazyloaded properly on Events tab
  • Set a new HLS Client ID everytime the source changes. Resolves some playback issues
  • Make Camera Grid on Events page scrollable so the page remains the same size no matter how many cameras you have.
  • Reduce some spacing in the frontend
  • The Hover Line which shows the time is now properly positioned
  • Connect to DB using the postgres user to allow running the container as root
  • Set default value for EXTINF for fragmented mp4s if it cant be read properly from the manifest file.
    This resolves an issue where playback and loading of the timeline would fail because there were segments that had EXTINF: null in the DB

If you get an error similar to this: psycopg2.OperationalError: connection to server at "localhost" (::1), port 5432 failed: FATAL: role "postgres" does not exist you need to stop Viseron and delete the postgresql folder in the config dir.

On next restart Viseron will recreate the DB with proper permissions

Assets 2
Loading

v3.0.0b1 - 24/7 recordings

28 Mar 23:03
@roflcoopter roflcoopter
v3.0.0b1
a20c630
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Learn about vigilant mode.
Compare
Choose a tag to compare
v3.0.0b1 - 24/7 recordings Pre-release
Pre-release

This is a pretty massive release that brings a number of new features and improvements.

Documentation can be found here: https://dev--viseron.netlify.app/

Features

24/7 recordings

The main feature developed here is the option of having 24/7 recordings.
With this comes a new component, storage which will allow you to retain data based on time (like it is today) and based one consumed space.
This allows you to use your storage to its maximum.

Storage Tiers

Another feature of the storage component are tiers.
They allow you to store recordings on multiple media.
Say you have one 256GB SSD and a 1TB HDD, you can keep the most recent recordings on the SSD for fast access while offloading the older recordings to the HDD for archiving.

Documentation for the storage component can be found here: https://dev--viseron.netlify.app/components-explorer/components/storage

Timeline

To easily view 24/7 recordings, a new Timeline view is available.
It currently shows continuous recordings, motion events, detected objects.
Face recognition and License plate recognition will be available soon as well.
viseron_v3_timeline_blur

Events

The Events view is a more concise view than the Timeline.
Here you can scroll through and view all the Events.
Currently it shows only recordings but more events like face recognition etc is in the works.
You cannot view 24/7 recordings here.
viseron_v3_events_blur

Breaking Changes

  • Old recordings are not yet migrated over to the new format and will not be viewable in Viseron
  • Recordings are now in HLS format. If you need to have the recordings saved as full MP4 files you can use the new config option create_event_clip
  • Recordings folder structure has changed
  • mp4 file extension is now forced and extension is removed
  • segments_folder is removed in favor of tier paths
  • Thumbnails are now stored in /thumbnails folder (depending on the tier config)
  • filename_pattern in thumbnail is removed, stored as ID of the recording

See the #716 v3.0.0 PR for tasks left to do before final release is ready.

Assets 2
Loading
148 Join discussion

v2.3.1 - Jetson Nano GStreamer fix

18 Sep 11:20
@roflcoopter roflcoopter
v2.3.1
8c15c61
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.
Compare
Choose a tag to compare
v2.3.1 - Jetson Nano GStreamer fix Latest
Latest

Fix Failed to load component gstreamer: No module named 'gi' for the jetson-nano container.

Closes #672

Assets 2
Loading

v2.3.0 - CodeProject AI and License Plate Recognition

14 Sep 13:53
@roflcoopter roflcoopter
v2.3.0
7df8ee5
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.
Compare
Choose a tag to compare
v2.3.0 - CodeProject AI and License Plate Recognition

This is a smaller release with a few new features and fixes.
I am working hard on 24/7 recordings that I hade planned to release together with these changes, but its taking a bit longer than i had anticipated.
If you are interested in that, sit tight for the next release! You can follow my progress here: #619

CodeProject AI component

A new component which leverages CodeProject AI's computer vision capabilities is included in this release.
As of now it supports object detection, face recognition as well as a new post processor, Automatic License Plate Recognition!

Automatic License Plate Recognition (ALPR)

A new post processor is now available for ALPR.
Currently only CodeProject AI supports it, but in the future more variants may be supported.

Developer Experience

I have started to work on a better Developer Experience together with some proper Developer documentation.
It is still in early stages and the inner workings of Viseron are not explained yet, but it will improve over time.

The biggest addition to the Developer Experience this release is the support for VSCode Devcontainers.
This makes it significantly easier to get going with development, as all you have to do is spin up the container!
I have been using this myself for some time now and it has accelerated my work significantly

The new Developer docs can be found here : https://viseron.netlify.app/docs/developers

Changes and fixes

There are also a small number of changes and improvements.

  • New config option for the camera domain, still_image
    It allows you to configure a URL to fetch the snapshots that are displayed in the UI from.
    Useful if you woudl lke to get full resolution still images in the UI while still using the substream for detection
    Under still_image you can specify refresh_interval which makes the UI refresh more often. Default is 10 seconds.
  • A mask helper has been added to the docs: https://viseron.netlify.app/components-explorer/components/mog2#mask
    This makes it a bit clearer how to configure them until its possible to do it from the frontend directly.
  • ffmpeg has a new config option raw_command that makes it possible to specify an FFmpeg command that will be used directly.
    Great if you want to test out some specific command that is hard to accomplish using the other available options.
    There are a number of things to keep in mind tho, so if you are going to use it, make sure to read the docs thoroughly.

What's Changed

Full Changelog: v2.2.0...v2.3.0

Contributors

roflcoopter
Assets 2
Loading

v2.2.0 - Authentication

22 Apr 07:23
@roflcoopter roflcoopter
v2.2.0
afc209c
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.
Compare
Choose a tag to compare
v2.2.0 - Authentication

This release contains a lot of tweaks and fixes as well as some cool new features!

Authentication

The biggest change in this release is the addition of authentication for the frontend/API.
It is disabled by default but can be enabled by adding auth to your webserver config.

webserver:
  auth:

When you first enable authentication you will be greeted with an onboarding page which allows you to create your first user.
At the moment you can only create this first user. Complete user handling is planned for the next release.
image

Enabling authentication protects all resources, including streams and videos, so if you are consuming these directly through Viserons API from another tool you will have some issues. I will make sure to properly implement and document a good way of accessing the API and resources from third-party tools even with auth enabled in a future release.

Things that needs to be added before i consider this feature done:

  • Long lived access tokens for third party consumers of the API
  • Create more users
  • Delete/update users
  • IP bans for failed login attempts

Failed cameras

Cameras that are unavailable during startup will now properly retry setup with automatic back-off.
Any camera that cant be successfully setup will be displayed in the frontend, displaying the error:
Failed_cameras

The red border represents failed cameras, and the orange border represents cameras that are actively retrying setup.
A bonus feature here is that the recordings for the cameras are still available for viewing in the frontend, neat right?!

General fixes

  • FFmpeg upgraded to 5.1.2 with improved hardware acceleration for RPi4
  • H265 fix for gstreamer
  • Audio is transcoded to aac by default if the original codec (pcm_alaw, pcm_mulaw) is not supported in .mp4 files.
    Previously recordings would be stored in .mkv files instead but that proved to be confusing.
  • Changed how dlib and sklearn is installed which should solve a lot of issues with this component on the jetson-nano and aarch64 image

What's Changed

Full Changelog: v2.1.1...v2.2.0

Contributors

roflcoopter
Assets 2
Loading

v2.2.0b1 - Authentication

01 Apr 07:05
@roflcoopter roflcoopter
v2.2.0b1
c441207
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.
Compare
Choose a tag to compare
v2.2.0b1 - Authentication Pre-release
Pre-release

This release contains a lot of tweaks and fixes as well as some cool new features!

Authentication

The biggest change in this release is the addition of authentication for the frontend/API.
It is disabled by default but can be enabled by adding auth to your webserver config.

webserver:
  auth:

When you first enable authentication you will be greeted with an onboarding page which allows you to create your first user.
At the moment you can only create this first user. Complete user handling is planned for the next release.
image

Enabling authentication protects all resources, including streams and videos, so if you are consuming these directly through Viserons API from another tool you will have some issues. I will make sure to properly implement and document a good way of accessing the API and resources from third-party tools even with auth enabled in a future release.

Things that needs to be added before i consider this feature done:

  • Long lived access tokens for third party consumers of the API
  • Create more users
  • Delete/update users
  • IP bans for failed login attempts

Failed cameras

Cameras that are unavailable during startup will now properly retry setup with automatic back-off.
Any camera that cant be successfully setup will be displayed in the frontend, displaying the error:
Failed_cameras

The red border represents failed cameras, and the orange border represents cameras that are actively retrying setup.
A bonus feature here is that the recordings for the cameras are still available for viewing in the frontend, neat right?!

General fixes

  • FFmpeg upgraded to 5.1.2 with improved hardware acceleration for RPi4
  • H265 fix for gstreamer
  • Audio is transcoded to aac by default if the original codec (pcm_alaw, pcm_mulaw) is not supported in .mp4 files.
    Previously recordings would be stored in .mkv files instead but that proved to be confusing.
  • Changed how dlib and sklearn is installed which should solve a lot of issues with this component on the jetson-nano and aarch64 image

What's Changed

Full Changelog: v2.1.1...v2.2.0b1

Contributors

roflcoopter
Assets 2
Loading

v2.1.1 - Recorder bugfixes

06 Mar 14:26
@roflcoopter roflcoopter
v2.1.1
9d07193
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.
Compare
Choose a tag to compare
v2.1.1 - Recorder bugfixes

This is a minor release containing a few new features as well as some bug fixes.
I recommend everyone running 2.1.0 to update immediately since 2.1.0 introduced a bug which creates shorter recordings than intended, which might make you miss important events.

New features

  • Recordings can now be deleted from the UI, either by camera, per day or individual recording.
  • Add output_args configuration option to allow better customization of the ffmpeg recorder command
  • aarch64 docker image now contains the yolov7 model family

Bugfixes

  • Fix calculation of event start and end time
  • Fixed handling of max_recorder_keepalive when running with only motion detection as trigger for the recorder.
  • Easier copying of the configuration key name from the docs page
  • Fix stream naming colission

What's Changed

New Contributors

Full Changelog: v2.1.0...v2.1.1

Contributors

l-maia and roflcoopter
Assets 2
Loading

v2.1.0 - Frontend improvements

31 Dec 10:10
@roflcoopter roflcoopter
v2.1.0
ed55649
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.
Compare
Choose a tag to compare
v2.1.0 - Frontend improvements

Frontend

Recordings grouped daily

Recordings are now grouped by day to reduce the amount of scrolling needed.
Each day will show the latest recording, along with a button to drill down to that days recordings.

Breadcrumbs

Breadcrumbs are added to the header for easier navigation

Layout fixes

Grid sizes are now more consistent across the different pages

Backend

OpenVINO backend for Darknet

Upgraded to OpenCV 4.6.0 with OpenVINO support for Darknet.
This means better hardware acceleration support on Intel CPUs.
YOLOv7 is now supported and is the default in all images.

Breaking changes

The attributes of the binary_sensor.{camera identifier}_recorder has changed slightly:

  • last_recording_start -> start_time
  • last_recording_end -> end_time

What's Changed

New Contributors

Full Changelog: v2.0.0...v2.1.0

Contributors

twodarek and roflcoopter
Assets 2
Loading

v2.0.0 - Viseron rewrite

19 Dec 11:28
@roflcoopter roflcoopter
v2.0.0
8e2edd9
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.
Compare
Choose a tag to compare
v2.0.0 - Viseron rewrite

This release features a massive rewrite that I have been working on for the past year.

It focuses on decoupling all parts of Viseron, making it more modularized. This allows for easier integration of new functionality.

The config.yaml file will change completely so there is some work that has to be done by each user to port over to the new version.
The general config format is a component which implements one or more domains.
Each camera has a unique camera identifier which flows through the entire configuration.

The nvr component then ties all these different domains together and provides the full functionality.

The big benefit of this new format is that you can mix and match components more freely.
For instance, you could use different object detectors for different cameras, you are not tied into just one.

Config example 
ffmpeg: # <-- component
  camera: # <-- domain
    camera_one: # <-- camera identifier
       name: Camera 1
       host: 192.168.10.10
       username: test
       password: test
    camera_two: # <-- camera identifier
       name: Camera 2
       host: 192.168.10.11
       username: test
       password: test
       ....

darknet: # <-- component
  object_detector: # <-- domain
    model: /my_custom_model/model.weights
    cameras:
      camera_one: # <-- camera identifier
        fps: 5

deepstack:  # <-- component
  host: deepstack # <-- component config option
  port: 5000 # <-- component config option
  object_detector: # <-- domain
    cameras:
      camera_two:  # <-- camera identifier
        fps: 1
        labels:
          - label: person
            confidence: 0.75
            trigger_recorder: false
  face_recognition: # <-- domain
    cameras:
      camera_one:
      camera_two:
    labels:
      - person

background_subtractor: # <-- component
  motion_detector: # <-- domain
    cameras:
      camera_one: # <-- camera identifier
        fps: 1
        mask:
          - coordinates:
              - x: 400
                y: 200
              - x: 1000
                y: 200
              - x: 1000
                y: 750
              - x: 400
                y: 750

nvr: # <-- component
  camera_one: # <-- camera identifier
  camera_two: # <-- camera identifier
Config example with publicly available cameras (used in the screenshots) 
ffmpeg:
  camera:
    viseron_camera:
      name: Camera 1
      host: 195.196.36.242
      path: /mjpg/video.mjpg
      port: 80
      stream_format: mjpeg
      fps: 6
      recorder:
        idle_timeout: 1
        codec: h264
    viseron_camera2:
      name: Camera 2
      host: storatorg.halmstad.se
      path: /mjpg/video.mjpg
      stream_format: mjpeg
      port: 443
      fps: 2
      protocol: https
      recorder:
        idle_timeout: 1
        codec: h264
    viseron_camera3:
      name: Camera 3
      host: 195.196.36.242
      path: /mjpg/video.mjpg
      port: 80
      stream_format: mjpeg
      fps: 6
      recorder:
        idle_timeout: 1
        codec: h264

mog2:
  motion_detector:
    cameras:
      viseron_camera:
        fps: 1
      viseron_camera2:
        fps: 1

background_subtractor:
  motion_detector:
    cameras:
      viseron_camera3:
        fps: 1
        mask:
          - coordinates:
              - x: 400
                y: 200
              - x: 1000
                y: 200
              - x: 1000
                y: 750
              - x: 400
                y: 750

darknet:
  object_detector:
    cameras:
      viseron_camera:
        fps: 1
        scan_on_motion_only: false
        labels:
          - label: person
            confidence: 0.8
            trigger_recorder: true
      viseron_camera2:
        fps: 1
        labels:
          - label: person
            confidence: 0.8
            trigger_recorder: true
      viseron_camera3:
        fps: 1
        labels:
          - label: person
            confidence: 0.8
            trigger_recorder: true

nvr:
  viseron_camera:
  viseron_camera2:
  viseron_camera3:

webserver:

mqtt:
  broker: mqtt_broker.lan
  port: 1883
  username: !secret mqtt_username
  password: !secret mqtt_password
  home_assistant:

logger:
  default_level: debug

Frontend

There is now a UI included in Viseron, written in React TypeScript.
It is enabled by default and can be reached on port 8888 inside the container by default.

Currently it features functionality like viewing cameras, recordings and editing the configuration.
It will be expanded upon in the future.

Some screenshots of the UI

Cameras:
Viseron-screenshot-cameras

Recordings:
Viseron-screenshot-recordings

Configuration:
Viseron-screenshot-configuration

Entities:
Viseron-screenshot-entities

Jetson Nano support

This release also features better Jetson Nano support through the gstreamer component.
This means that you can utilize your Nano for hardware accelerated camera decoding and object detection.

CompreFace face recognition

Face recognition using CompreFace is now available

Image classification

A new post processor is available, image_classification.
This allows you to get more granular results from a detected object.
As an example, you could detect a specific kind of dog breed, or a specific kind of bird.

Multiprocessing

darknet and edgetpu object detectos utilize multiprocessing which spreads the load between multiple processes.
This allows for better performance, but also makes it easier to analyze and fine tune the load on your system.

Documentation site

The documentation has moved over from being in a README format to a dedicated site.
Hopefully it will help you use Viseron better.
I need your help on how it can be improved, writing good docs is always hard.

I am especially proud of the components page, which is mostly generated from the config schema used.
This means that the documentation and schema will always match, yay!

The documentation is hosted here: https://viseron.netlify.app/

Breaking changes

  • ALL kinds of inheritance in the config has been removed.
    This means that you have to explicitly configure your object detector and motion detector settings for each camera.

  • interval has been removed from object_detection and motion_detection
    A new config option fps will be used instead.
    This change was made since it was quite confusing, both in the code and for the users because interval was specified in seconds.

  • logging has been removed in all shapes and forms and has been replaced with the new component logger
    Please see the updated documentation

  • cameras config section has been removed. Camera config is now specified under a component.

  • Each object detector has been split up into individual components.
    See the documentation for each detector.

  • Each motion detector has been split up into individual components.
    See the documentation for each detector.

  • recorder can no longer be configured on a global level.
    It now has to be present under each camera configuration.

  • timeout under recorder is now called idle_timeout

  • static_mjpeg_streams are now called mjpeg_streams

  • enable under object_detection is no more. To disable object detection you simply dont configure it for a camera
    Same goes for motion_detector

  • timeout for motion_detector is now called recorder_keepalive

  • max_timeout for motion_detector is now called max_recorder_keepalive

  • Recordings are now stored in the folder structure /recordings/<camera name>/<date>/<timestamp>.mp4

  • Images are no longer streamed to MQTT/Home Assistant, with the exception of thumbnails.
    This is because MQTT is not really suited for this and it impacts performance a lot.
    If you still want to have the cameras in Home Assistant you can point Home Assistant to an MJPEG stream in Viseron.

  • filter_args removed for camera and recorder.
    For camera, use video_filters instead.
    For recorder, you can use both video_filters and audio_filters

    Short config example to rotate video 180 degrees: 
    ffmpeg:
  camera:
    camera_1:
    ....
      video_filters:   # These filters rotate the images processed by Viseron
        - transpose=2
        - transpose=2
      recorder:
        video_filters:   # These filters rotate the recorded video
          - transpose=2
          - transpose=2

What's Changed

Read more

Contributors

olekenneth, DevelopIdeas, and roflcoopter
Assets 2
Loading
12 Join discussion

v2.0.0b4 - Entities

05 Dec 07:17
@roflcoopter roflcoopter
v2.0.0b4
de8d8e2
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.
Compare
Choose a tag to compare
v2.0.0b4 - Entities Pre-release
Pre-release

This release features a new Entities Page where you can browse all the entities in Viseron.
At the moment you can only view the current states, not change them or view any history.

image

This will most likely be the last beta before official release unless something unexpected happens.

What's Changed

Full Changelog: v2.0.0b3...v2.0.0b4

Contributors

roflcoopter
Assets 2
Loading