doorapi

Documentation

Index

• func CurrentStateEndpoint(grp *app.Router)
• func OverwriteEndpoint(grp *app.Router)
• func ResetDoorEndpoint(grp *app.Router)
• func Setup(a *app.App, grp *echo.Group)
• func TestStateEndpoint(grp *app.Router)

Functions

func CurrentStateEndpoint

func CurrentStateEndpoint(grp *app.Router)

CurrentStateEndpoint returns the current state of the door and when the next state change is expected.

func OverwriteEndpoint

func OverwriteEndpoint(grp *app.Router)

OverwriteEndpoint allows to overwrite the door state for a specified amount of time.

func ResetDoorEndpoint

func ResetDoorEndpoint(grp *app.Router)

ResetDoorEndpoint resets the door controller and the door itself and re-applies the current expected state.

func Setup

func Setup(a *app.App, grp *echo.Group)

Setup registers all routes for the door controller.

func TestStateEndpoint

func TestStateEndpoint(grp *app.Router)

TestStateEndpoint allows to test the desired door state for any point in time.