cameraapp

Documentation

Overview

Package cameraapp demonstrates an app that can send images from a connected webcam to Home Assistant. It exposes the camera entity (through which images are published) as well as start and stop button entities for starting/stopping the camera respectively.

It uses the excellent github.com/vladimirvivien/go4vl package for camera access.

Unfortunately, this example app only runs on Linux.

Index

• Variables
• type CameraApp
  • func New(ctx context.Context) (*CameraApp, error)
  • func (a *CameraApp) Configuration() []*mqttapi.Msg
  • func (a *CameraApp) MsgCh() chan *mqttapi.Msg
  • func (a *CameraApp) Name() string
  • func (a *CameraApp) States() []*mqttapi.Msg
  • func (a *CameraApp) Subscriptions() []*mqttapi.Subscription
  • func (a *CameraApp) Update(_ context.Context) error

Variables

var ErrUnsupportedOS = errors.New("example camera app only runs on Linux")

Types

type CameraApp

type CameraApp struct {
	// contains filtered or unexported fields
}

CameraApp is our struct that represents an app to Go Hass Anything.

func New

func New(ctx context.Context) (*CameraApp, error)

New sets up our example app. It creates entities for the camera images and start and stop buttons.

func (*CameraApp) Configuration

func (a *CameraApp) Configuration() []*mqttapi.Msg

func (*CameraApp) MsgCh

func (a *CameraApp) MsgCh() chan *mqttapi.Msg

Our channel on which we send camera images as MQTT messages.

func (*CameraApp) Name

func (a *CameraApp) Name() string

func (*CameraApp) States

func (a *CameraApp) States() []*mqttapi.Msg

States is unused in this example app. This could be used to take an image snapshot via the webcam or expose other camera information as entities...

func (*CameraApp) Subscriptions

func (a *CameraApp) Subscriptions() []*mqttapi.Subscription

func (*CameraApp) Update

func (a *CameraApp) Update(_ context.Context) error

Update is unused, there is no app data to update.