commands

package
v0.8.10 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 30, 2025 License: MIT Imports: 23 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var ActivateKeypadsCmd = ActivateKeypads{}
View Source 
var AddTaskCmd = AddTask{}
View Source 
var ClearTaskListCmd = ClearTaskList{}
View Source 
var ClearTimeProfilesCmd = ClearTimeProfiles{}
View Source 
var CompareACLCmd = CompareACL{
	// contains filtered or unexported fields
}

CompareACLCmd is an initialized CompareACL command for the main() command list

View Source 
var DeleteCardCmd = DeleteCard{}
View Source 
var DeleteCardsCmd = DeleteCards{}
View Source 
var GetACLCmd = GetACL{
	// contains filtered or unexported fields
}
View Source 
var GetCardCmd = GetCard{}
View Source 
var GetCardsCmd = GetCards{}
View Source 
var GetDeviceCmd = GetDevice{}
View Source 
var GetDevicesCmd = GetDevices{}
View Source 
var GetDoorControlCmd = GetDoorControl{}
View Source 
var GetDoorDelayCmd = GetDoorDelay{}
View Source 
var GetEventCmd = GetEvent{}
View Source 
var GetEventIndexCmd = GetEventIndex{}
View Source 
var GetEventsCmd = GetEvents{}
View Source 
var GetListenerCmd = GetListener{}
View Source 
var GetStatusCmd = GetStatus{}
View Source 
var GetTimeCmd = GetTime{}
View Source 
var GetTimeProfileCmd = GetTimeProfile{}
View Source 
var GetTimeProfilesCmd = GetTimeProfiles{
	// contains filtered or unexported fields
}
View Source 
var GrantCmd = Grant{}
View Source 
var ListenCmd = Listen{}
View Source 
var LoadACLCmd = LoadACL{
	// contains filtered or unexported fields
}
View Source 
var OpenDoorCmd = OpenDoor{}
View Source 
var PutCardCmd = PutCard{}
View Source 
var RecordSpecialEventsCmd = RecordSpecialEvents{}
View Source 
var RefreshTaskListCmd = RefreshTaskList{}
View Source 
var RestoreDefaultParametersCmd = RestoreDefaultParameters{}

RestoreDefaultParameters command variable for CLI command list.

View Source 
var RevokeCmd = Revoke{}
View Source 
var SetAddressCmd = SetAddress{}
View Source 
var SetDoorControlCmd = SetDoorControl{}
View Source 
var SetDoorDelayCmd = SetDoorDelay{}
View Source 
var SetDoorPasscodesCmd = SetDoorPasscodes{}

SetDoorPasscodes command variable for CLI command list.

View Source 
var SetEventIndexCmd = SetEventIndex{}
View Source 
var SetInterlockCmd = SetInterlock{}
View Source 
var SetListenerCmd = SetListener{}
View Source 
var SetPCControlCmd = SetPCControl{}
View Source 
var SetTaskListCmd = SetTaskList{}
View Source 
var SetTimeCmd = SetTime{}
View Source 
var SetTimeProfileCmd = SetTimeProfile{}
View Source 
var SetTimeProfilesCmd = SetTimeProfiles{}
View Source 
var ShowCmd = Show{}
View Source 
var VersionCmd = Version{}

VersionCmd is an initialized Version command for the main() command list

Functions

This section is empty.

Types

type ActivateKeypads added in v0.8.6 

type ActivateKeypads struct {
}

func (*ActivateKeypads) CLI added in v0.8.6 

func (c *ActivateKeypads) CLI() string

func (*ActivateKeypads) Description added in v0.8.6 

func (c *ActivateKeypads) Description() string

func (*ActivateKeypads) Execute added in v0.8.6 

func (c *ActivateKeypads) Execute(ctx Context) error

func (*ActivateKeypads) Help added in v0.8.6 

func (c *ActivateKeypads) Help()

func (*ActivateKeypads) RequiresConfig added in v0.8.6 

func (c *ActivateKeypads) RequiresConfig() bool

Returns false - configuration is useful but optional.

func (*ActivateKeypads) Usage added in v0.8.6 

func (c *ActivateKeypads) Usage() string

type AddTask added in v0.7.1 

type AddTask struct {
}

func (*AddTask) CLI added in v0.7.1 

func (c *AddTask) CLI() string

func (*AddTask) Description added in v0.7.1 

func (c *AddTask) Description() string

func (*AddTask) Execute added in v0.7.1 

func (c *AddTask) Execute(ctx Context) error

func (*AddTask) Help added in v0.7.1 

func (c *AddTask) Help()

func (*AddTask) RequiresConfig added in v0.7.1 

func (c *AddTask) RequiresConfig() bool

Returns false - configuration is useful but optional.

func (*AddTask) Usage added in v0.7.1 

func (c *AddTask) Usage() string

type ClearTaskList added in v0.7.1 

type ClearTaskList struct {
}

func (*ClearTaskList) CLI added in v0.7.1 

func (c *ClearTaskList) CLI() string

func (*ClearTaskList) Description added in v0.7.1 

func (c *ClearTaskList) Description() string

func (*ClearTaskList) Execute added in v0.7.1 

func (c *ClearTaskList) Execute(ctx Context) error

func (*ClearTaskList) Help added in v0.7.1 

func (c *ClearTaskList) Help()

func (*ClearTaskList) RequiresConfig added in v0.7.1 

func (c *ClearTaskList) RequiresConfig() bool

Returns false - configuration is useful but optional.

func (*ClearTaskList) Usage added in v0.7.1 

func (c *ClearTaskList) Usage() string

type ClearTimeProfiles added in v0.7.0 

type ClearTimeProfiles struct {
}

func (*ClearTimeProfiles) CLI added in v0.7.0 

func (c *ClearTimeProfiles) CLI() string

func (*ClearTimeProfiles) Description added in v0.7.0 

func (c *ClearTimeProfiles) Description() string

func (*ClearTimeProfiles) Execute added in v0.7.0 

func (c *ClearTimeProfiles) Execute(ctx Context) error

func (*ClearTimeProfiles) Help added in v0.7.0 

func (c *ClearTimeProfiles) Help()

func (*ClearTimeProfiles) RequiresConfig added in v0.7.0 

func (c *ClearTimeProfiles) RequiresConfig() bool

Returns false - configuration is useful but optional.

func (*ClearTimeProfiles) Usage added in v0.7.0 

func (c *ClearTimeProfiles) Usage() string

type Command 

type Command interface {
	Execute(context Context) error
	CLI() string
	Description() string
	Usage() string
	Help()
	RequiresConfig() bool
}

Command defines the common functions for CLI command implementations. This will be replaced with the 'uhppoted-lib' implementation in a future iteration.

type CompareACL 

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

func (*CompareACL) CLI 

func (c *CompareACL) CLI() string

func (*CompareACL) Description 

func (c *CompareACL) Description() string

func (*CompareACL) Execute 

func (c *CompareACL) Execute(ctx Context) error

func (*CompareACL) Help 

func (c *CompareACL) Help()

func (*CompareACL) RequiresConfig 

func (c *CompareACL) RequiresConfig() bool

Returns true - configuration is not optional for this command to return valid information.

func (*CompareACL) Usage 

func (c *CompareACL) Usage() string

type Context 

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

Context contains the environment and configuration information required for all commands

func NewContext 

func NewContext(u uhppote.IUHPPOTE, c *config.Config, debug bool) Context

NewContext returns a valid Context initialized with the supplied UHPPOTE and configuration.

type DeleteCard 

type DeleteCard struct {
}

func (*DeleteCard) CLI 

func (c *DeleteCard) CLI() string

func (*DeleteCard) Description 

func (c *DeleteCard) Description() string

func (*DeleteCard) Execute 

func (c *DeleteCard) Execute(ctx Context) error

func (*DeleteCard) Help 

func (c *DeleteCard) Help()

func (*DeleteCard) RequiresConfig 

func (c *DeleteCard) RequiresConfig() bool

Returns false - configuration is useful but optional.

func (*DeleteCard) Usage 

func (c *DeleteCard) Usage() string

type DeleteCards added in v0.7.0 

type DeleteCards struct {
}

func (*DeleteCards) CLI added in v0.7.0 

func (c *DeleteCards) CLI() string

func (*DeleteCards) Description added in v0.7.0 

func (c *DeleteCards) Description() string

func (*DeleteCards) Execute added in v0.7.0 

func (c *DeleteCards) Execute(ctx Context) error

func (*DeleteCards) Help added in v0.7.0 

func (c *DeleteCards) Help()

func (*DeleteCards) RequiresConfig added in v0.7.0 

func (c *DeleteCards) RequiresConfig() bool

Returns false - configuration is useful but optional.

func (*DeleteCards) Usage added in v0.7.0 

func (c *DeleteCards) Usage() string

type GetACL 

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

func (*GetACL) CLI 

func (c *GetACL) CLI() string

func (*GetACL) Description 

func (c *GetACL) Description() string

func (*GetACL) Execute 

func (c *GetACL) Execute(ctx Context) error

func (*GetACL) Help 

func (c *GetACL) Help()

func (*GetACL) RequiresConfig 

func (c *GetACL) RequiresConfig() bool

Returns true - configuration is not optional for this command to return valid information.

func (*GetACL) Usage 

func (c *GetACL) Usage() string

type GetCard 

type GetCard struct {
}

func (*GetCard) CLI 

func (c *GetCard) CLI() string

func (*GetCard) Description 

func (c *GetCard) Description() string

func (*GetCard) Execute 

func (c *GetCard) Execute(ctx Context) error

func (*GetCard) Help 

func (c *GetCard) Help()

func (*GetCard) RequiresConfig 

func (c *GetCard) RequiresConfig() bool

Returns false - configuration is useful but optional.

func (*GetCard) Usage 

func (c *GetCard) Usage() string

type GetCards 

type GetCards struct {
}

func (*GetCards) CLI 

func (c *GetCards) CLI() string

func (*GetCards) Description 

func (c *GetCards) Description() string

func (*GetCards) Execute 

func (c *GetCards) Execute(ctx Context) error

func (*GetCards) Help 

func (c *GetCards) Help()

func (*GetCards) RequiresConfig 

func (c *GetCards) RequiresConfig() bool

Returns false - configuration is useful but optional.

func (*GetCards) Usage 

func (c *GetCards) Usage() string

type GetDevice 

type GetDevice struct {
}

func (*GetDevice) CLI 

func (c *GetDevice) CLI() string

func (*GetDevice) Description 

func (c *GetDevice) Description() string

func (*GetDevice) Execute 

func (c *GetDevice) Execute(ctx Context) error

func (*GetDevice) Help 

func (c *GetDevice) Help()

func (*GetDevice) RequiresConfig 

func (c *GetDevice) RequiresConfig() bool

Returns false - configuration is useful but optional.

func (*GetDevice) Usage 

func (c *GetDevice) Usage() string

type GetDevices 

type GetDevices struct {
}

func (*GetDevices) CLI 

func (c *GetDevices) CLI() string

func (*GetDevices) Description 

func (c *GetDevices) Description() string

func (*GetDevices) Execute 

func (c *GetDevices) Execute(ctx Context) error

func (*GetDevices) Help 

func (c *GetDevices) Help()

func (*GetDevices) RequiresConfig 

func (c *GetDevices) RequiresConfig() bool

Returns false - configuration is useful but optional.

func (*GetDevices) Usage 

func (c *GetDevices) Usage() string

type GetDoorControl 

type GetDoorControl struct {
}

func (*GetDoorControl) CLI 

func (c *GetDoorControl) CLI() string

func (*GetDoorControl) Description 

func (c *GetDoorControl) Description() string

func (*GetDoorControl) Execute 

func (c *GetDoorControl) Execute(ctx Context) error

func (*GetDoorControl) Help 

func (c *GetDoorControl) Help()

func (*GetDoorControl) RequiresConfig 

func (c *GetDoorControl) RequiresConfig() bool

Returns false - configuration is useful but optional.

func (*GetDoorControl) Usage 

func (c *GetDoorControl) Usage() string

type GetDoorDelay 

type GetDoorDelay struct {
}

func (*GetDoorDelay) CLI 

func (c *GetDoorDelay) CLI() string

func (*GetDoorDelay) Description 

func (c *GetDoorDelay) Description() string

func (*GetDoorDelay) Execute 

func (c *GetDoorDelay) Execute(ctx Context) error

func (*GetDoorDelay) Help 

func (c *GetDoorDelay) Help()

func (*GetDoorDelay) RequiresConfig 

func (c *GetDoorDelay) RequiresConfig() bool

Returns false - configuration is useful but optional.

func (*GetDoorDelay) Usage 

func (c *GetDoorDelay) Usage() string

type GetEvent 

type GetEvent struct {
}

func (*GetEvent) CLI 

func (c *GetEvent) CLI() string

func (*GetEvent) Description 

func (c *GetEvent) Description() string

func (*GetEvent) Execute 

func (c *GetEvent) Execute(ctx Context) error

func (*GetEvent) Help 

func (c *GetEvent) Help()

func (*GetEvent) RequiresConfig 

func (c *GetEvent) RequiresConfig() bool

Returns false - configuration is useful but optional.

func (*GetEvent) Usage 

func (c *GetEvent) Usage() string

type GetEventIndex 

type GetEventIndex struct {
}

func (*GetEventIndex) CLI 

func (c *GetEventIndex) CLI() string

func (*GetEventIndex) Description 

func (c *GetEventIndex) Description() string

func (*GetEventIndex) Execute 

func (c *GetEventIndex) Execute(ctx Context) error

func (*GetEventIndex) Help 

func (c *GetEventIndex) Help()

func (*GetEventIndex) RequiresConfig 

func (c *GetEventIndex) RequiresConfig() bool

Returns false - configuration is useful but optional.

func (*GetEventIndex) Usage 

func (c *GetEventIndex) Usage() string

type GetEvents 

type GetEvents struct {
}

func (*GetEvents) CLI 

func (c *GetEvents) CLI() string

func (*GetEvents) Description 

func (c *GetEvents) Description() string

func (*GetEvents) Execute 

func (c *GetEvents) Execute(ctx Context) error

func (*GetEvents) Help 

func (c *GetEvents) Help()

func (*GetEvents) RequiresConfig 

func (c *GetEvents) RequiresConfig() bool

Returns false - configuration is useful but optional.

func (*GetEvents) Usage 

func (c *GetEvents) Usage() string

type GetListener 

type GetListener struct {
}

func (*GetListener) CLI 

func (c *GetListener) CLI() string

func (*GetListener) Description 

func (c *GetListener) Description() string

func (*GetListener) Execute 

func (c *GetListener) Execute(ctx Context) error

func (*GetListener) Help 

func (c *GetListener) Help()

func (*GetListener) RequiresConfig 

func (c *GetListener) RequiresConfig() bool

Returns false - configuration is useful but optional.

func (*GetListener) Usage 

func (c *GetListener) Usage() string

type GetStatus 

type GetStatus struct {
}

func (*GetStatus) CLI 

func (c *GetStatus) CLI() string

func (*GetStatus) Description 

func (c *GetStatus) Description() string

func (*GetStatus) Execute 

func (c *GetStatus) Execute(ctx Context) error

func (*GetStatus) Help 

func (c *GetStatus) Help()

func (*GetStatus) RequiresConfig 

func (c *GetStatus) RequiresConfig() bool

Returns false - configuration is useful but optional.

func (*GetStatus) Usage 

func (c *GetStatus) Usage() string

type GetTime 

type GetTime struct {
}

func (*GetTime) CLI 

func (c *GetTime) CLI() string

func (*GetTime) Description 

func (c *GetTime) Description() string

func (*GetTime) Execute 

func (c *GetTime) Execute(ctx Context) error

func (*GetTime) Help 

func (c *GetTime) Help()

func (*GetTime) RequiresConfig 

func (c *GetTime) RequiresConfig() bool

Returns false - configuration is useful but optional.

func (*GetTime) Usage 

func (c *GetTime) Usage() string

type GetTimeProfile added in v0.7.0 

type GetTimeProfile struct {
}

func (*GetTimeProfile) CLI added in v0.7.0 

func (c *GetTimeProfile) CLI() string

func (*GetTimeProfile) Description added in v0.7.0 

func (c *GetTimeProfile) Description() string

func (*GetTimeProfile) Execute added in v0.7.0 

func (c *GetTimeProfile) Execute(ctx Context) error

func (*GetTimeProfile) Help added in v0.7.0 

func (c *GetTimeProfile) Help()

func (*GetTimeProfile) RequiresConfig added in v0.7.0 

func (c *GetTimeProfile) RequiresConfig() bool

Returns false - configuration is useful but optional.

func (*GetTimeProfile) Usage added in v0.7.0 

func (c *GetTimeProfile) Usage() string

type GetTimeProfiles added in v0.7.0 

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

func (*GetTimeProfiles) CLI added in v0.7.0 

func (c *GetTimeProfiles) CLI() string

func (*GetTimeProfiles) Description added in v0.7.0 

func (c *GetTimeProfiles) Description() string

func (*GetTimeProfiles) Execute added in v0.7.0 

func (c *GetTimeProfiles) Execute(ctx Context) error

func (*GetTimeProfiles) Help added in v0.7.0 

func (c *GetTimeProfiles) Help()

func (*GetTimeProfiles) RequiresConfig added in v0.7.0 

func (c *GetTimeProfiles) RequiresConfig() bool

Returns false - configuration is useful but optional.

func (*GetTimeProfiles) Usage added in v0.7.0 

func (c *GetTimeProfiles) Usage() string

type Grant 

type Grant struct {
}

func (*Grant) CLI 

func (c *Grant) CLI() string

func (*Grant) Description 

func (c *Grant) Description() string

func (*Grant) Execute 

func (c *Grant) Execute(ctx Context) error

func (*Grant) Help 

func (c *Grant) Help()

func (*Grant) RequiresConfig 

func (c *Grant) RequiresConfig() bool

Returns true - configuration is not optional for this command to return valid information.

func (*Grant) Usage 

func (c *Grant) Usage() string

type Listen 

type Listen struct {
}

func (*Listen) CLI 

func (c *Listen) CLI() string

func (*Listen) Description 

func (c *Listen) Description() string

func (*Listen) Execute 

func (c *Listen) Execute(ctx Context) error

func (*Listen) Help 

func (c *Listen) Help()

func (*Listen) RequiresConfig 

func (c *Listen) RequiresConfig() bool

Returns false - configuration is useful but optional.

func (*Listen) Usage 

func (c *Listen) Usage() string

type LoadACL 

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

func (*LoadACL) CLI 

func (c *LoadACL) CLI() string

func (*LoadACL) Description 

func (c *LoadACL) Description() string

func (*LoadACL) Execute 

func (c *LoadACL) Execute(ctx Context) error

func (*LoadACL) Help 

func (c *LoadACL) Help()

func (*LoadACL) RequiresConfig 

func (c *LoadACL) RequiresConfig() bool

Returns true - configuration is not optional for this command to return valid information.

func (*LoadACL) Usage 

func (c *LoadACL) Usage() string

type OpenDoor 

type OpenDoor struct {
}

func (*OpenDoor) CLI 

func (c *OpenDoor) CLI() string

func (*OpenDoor) Description 

func (c *OpenDoor) Description() string

func (*OpenDoor) Execute 

func (c *OpenDoor) Execute(ctx Context) error

func (*OpenDoor) Help 

func (c *OpenDoor) Help()

func (*OpenDoor) RequiresConfig 

func (c *OpenDoor) RequiresConfig() bool

Returns false - configuration is useful but optional.

func (*OpenDoor) Usage 

func (c *OpenDoor) Usage() string

type PutCard 

type PutCard struct {
}

func (*PutCard) CLI 

func (c *PutCard) CLI() string

func (*PutCard) Description 

func (c *PutCard) Description() string

func (*PutCard) Execute 

func (c *PutCard) Execute(ctx Context) error

func (*PutCard) Help 

func (c *PutCard) Help()

func (*PutCard) RequiresConfig 

func (c *PutCard) RequiresConfig() bool

Returns false - configuration is useful but optional.

func (*PutCard) Usage 

func (c *PutCard) Usage() string

type RecordSpecialEvents added in v0.6.7 

type RecordSpecialEvents struct {
}

Command implementation for record-special-events to enable or disable events for door open, door closed and door button pressed.

func (*RecordSpecialEvents) CLI added in v0.6.7 

func (c *RecordSpecialEvents) CLI() string

Returns the 'record-special-events' command string for the CLI interface.

func (*RecordSpecialEvents) Description added in v0.6.7 

func (c *RecordSpecialEvents) Description() string

Returns the 'record-special-events' command summary for the CLI interface.

func (*RecordSpecialEvents) Execute added in v0.6.7 

func (c *RecordSpecialEvents) Execute(ctx Context) error

Gets the device ID and enable/disable value from the command line and sends a record-special-events to the designated controller.

func (*RecordSpecialEvents) Help added in v0.6.7 

func (c *RecordSpecialEvents) Help()

Outputs the 'record-special-events' command help for the CLI interface.

func (*RecordSpecialEvents) RequiresConfig added in v0.6.7 

func (c *RecordSpecialEvents) RequiresConfig() bool

Returns false - configuration is useful but optional.

func (*RecordSpecialEvents) Usage added in v0.6.7 

func (c *RecordSpecialEvents) Usage() string

Returns the 'record-special-events' command parameters for the CLI interface.

type RefreshTaskList added in v0.7.1 

type RefreshTaskList struct {
}

func (*RefreshTaskList) CLI added in v0.7.1 

func (c *RefreshTaskList) CLI() string

func (*RefreshTaskList) Description added in v0.7.1 

func (c *RefreshTaskList) Description() string

func (*RefreshTaskList) Execute added in v0.7.1 

func (c *RefreshTaskList) Execute(ctx Context) error

func (*RefreshTaskList) Help added in v0.7.1 

func (c *RefreshTaskList) Help()

func (*RefreshTaskList) RequiresConfig added in v0.7.1 

func (c *RefreshTaskList) RequiresConfig() bool

Returns false - configuration is useful but optional.

func (*RefreshTaskList) Usage added in v0.7.1 

func (c *RefreshTaskList) Usage() string

type RestoreDefaultParameters added in v0.8.8 

type RestoreDefaultParameters struct {
}

Command implementation for restore-default-parameters to reset a controller to the manufacturer default configuration.

func (*RestoreDefaultParameters) CLI added in v0.8.8 

func (c *RestoreDefaultParameters) CLI() string

Returns the 'restore-default-parameters' command string for the CLI interface.

func (*RestoreDefaultParameters) Description added in v0.8.8 

func (c *RestoreDefaultParameters) Description() string

Returns the 'restore-default-parameters' command summary for the CLI interface.

func (*RestoreDefaultParameters) Execute added in v0.8.8 

func (c *RestoreDefaultParameters) Execute(ctx Context) error

Gets the controller ID from the command line and sends a restore-default-parameters command to the designated controller.

func (*RestoreDefaultParameters) Help added in v0.8.8 

func (c *RestoreDefaultParameters) Help()

Outputs the 'restore-default-parameters' command help for the CLI interface.

func (*RestoreDefaultParameters) RequiresConfig added in v0.8.8 

func (c *RestoreDefaultParameters) RequiresConfig() bool

Returns false - configuration is useful but optional.

func (*RestoreDefaultParameters) Usage added in v0.8.8 

func (c *RestoreDefaultParameters) Usage() string

Returns the 'restore-default-parameters' command parameters for the CLI interface.

type Revoke 

type Revoke struct {
}

func (*Revoke) CLI 

func (c *Revoke) CLI() string

func (*Revoke) Description 

func (c *Revoke) Description() string

func (*Revoke) Execute 

func (c *Revoke) Execute(ctx Context) error

func (*Revoke) Help 

func (c *Revoke) Help()

func (*Revoke) RequiresConfig 

func (c *Revoke) RequiresConfig() bool

Returns true - configuration is not optional for this command to return valid information.

func (*Revoke) Usage 

func (c *Revoke) Usage() string

type SetAddress 

type SetAddress struct {
}

func (*SetAddress) CLI 

func (c *SetAddress) CLI() string

func (*SetAddress) Description 

func (c *SetAddress) Description() string

func (*SetAddress) Execute 

func (c *SetAddress) Execute(ctx Context) error

func (*SetAddress) Help 

func (c *SetAddress) Help()

func (*SetAddress) RequiresConfig 

func (c *SetAddress) RequiresConfig() bool

Returns false - configuration is useful but optional.

func (*SetAddress) Usage 

func (c *SetAddress) Usage() string

type SetDoorControl 

type SetDoorControl struct {
}

func (*SetDoorControl) CLI 

func (c *SetDoorControl) CLI() string

func (*SetDoorControl) Description 

func (c *SetDoorControl) Description() string

func (*SetDoorControl) Execute 

func (c *SetDoorControl) Execute(ctx Context) error

func (*SetDoorControl) Help 

func (c *SetDoorControl) Help()

func (*SetDoorControl) RequiresConfig 

func (c *SetDoorControl) RequiresConfig() bool

Returns false - configuration is useful but optional.

func (*SetDoorControl) Usage 

func (c *SetDoorControl) Usage() string

type SetDoorDelay 

type SetDoorDelay struct {
}

func (*SetDoorDelay) CLI 

func (c *SetDoorDelay) CLI() string

func (*SetDoorDelay) Description 

func (c *SetDoorDelay) Description() string

func (*SetDoorDelay) Execute 

func (c *SetDoorDelay) Execute(ctx Context) error

func (*SetDoorDelay) Help 

func (c *SetDoorDelay) Help()

func (*SetDoorDelay) RequiresConfig 

func (c *SetDoorDelay) RequiresConfig() bool

Returns false - configuration is useful but optional.

func (*SetDoorDelay) Usage 

func (c *SetDoorDelay) Usage() string

type SetDoorPasscodes added in v0.8.7 

type SetDoorPasscodes struct {
}

Command implementation for set-door-passcodes to set up to four supervisor passcodes for a door.

The command will use up to four of the codes supplied on the command line. Valid passcodes are PIN codes in the range [1..999999] and invalid codes will be replaced with a 0 PIN ('no code').

func (*SetDoorPasscodes) CLI added in v0.8.7 

func (c *SetDoorPasscodes) CLI() string

Returns the 'set-door-passcodes' command string for the CLI interface.

func (*SetDoorPasscodes) Description added in v0.8.7 

func (c *SetDoorPasscodes) Description() string

Returns the 'set-door-passcodes' command summary for the CLI interface.

func (*SetDoorPasscodes) Execute added in v0.8.7 

func (c *SetDoorPasscodes) Execute(ctx Context) error

Gets the device ID, door and passwords list from the command line and sends a set-super-control command to the designated controller.

func (*SetDoorPasscodes) Help added in v0.8.7 

func (c *SetDoorPasscodes) Help()

Outputs the 'set-door-passcodes' command help for the CLI interface.

func (*SetDoorPasscodes) RequiresConfig added in v0.8.7 

func (c *SetDoorPasscodes) RequiresConfig() bool

Returns false - configuration is useful but optional.

func (*SetDoorPasscodes) Usage added in v0.8.7 

func (c *SetDoorPasscodes) Usage() string

Returns the 'set-door-passcodes' command parameters for the CLI interface.

type SetEventIndex 

type SetEventIndex struct {
}

func (*SetEventIndex) CLI 

func (c *SetEventIndex) CLI() string

func (*SetEventIndex) Description 

func (c *SetEventIndex) Description() string

func (*SetEventIndex) Execute 

func (c *SetEventIndex) Execute(ctx Context) error

func (*SetEventIndex) Help 

func (c *SetEventIndex) Help()

func (*SetEventIndex) RequiresConfig 

func (c *SetEventIndex) RequiresConfig() bool

Returns false - configuration is useful but optional.

func (*SetEventIndex) Usage 

func (c *SetEventIndex) Usage() string

type SetInterlock added in v0.8.5 

type SetInterlock struct {
}

func (*SetInterlock) CLI added in v0.8.5 

func (c *SetInterlock) CLI() string

func (*SetInterlock) Description added in v0.8.5 

func (c *SetInterlock) Description() string

func (*SetInterlock) Execute added in v0.8.5 

func (c *SetInterlock) Execute(ctx Context) error

func (*SetInterlock) Help added in v0.8.5 

func (c *SetInterlock) Help()

func (*SetInterlock) RequiresConfig added in v0.8.5 

func (c *SetInterlock) RequiresConfig() bool

Returns false - configuration is useful but optional.

func (*SetInterlock) Usage added in v0.8.5 

func (c *SetInterlock) Usage() string

type SetListener 

type SetListener struct {
}

func (*SetListener) CLI 

func (c *SetListener) CLI() string

func (*SetListener) Description 

func (c *SetListener) Description() string

func (*SetListener) Execute 

func (c *SetListener) Execute(ctx Context) error

func (*SetListener) Help 

func (c *SetListener) Help()

func (*SetListener) RequiresConfig 

func (c *SetListener) RequiresConfig() bool

Returns false - configuration is useful but optional.

func (*SetListener) Usage 

func (c *SetListener) Usage() string

type SetPCControl added in v0.8.4 

type SetPCControl struct {
}

Command implementation for set-pc-control to enable or disable remote host access control.

The access controller expects the host to communicate at least once every 30 seconds otherwise it reverts to local control of access using the stored list of cards (the communication does not have to a 'set-pc-control' command). If the access controller has reverted to local control because no message has been received from the host for more than 30 seconds, any subsequent communication from the remote host will re-establish remote control again.

func (*SetPCControl) CLI added in v0.8.4 

func (c *SetPCControl) CLI() string

Returns the 'set-pc-control' command string for the CLI interface.

func (*SetPCControl) Description added in v0.8.4 

func (c *SetPCControl) Description() string

Returns the 'set-pc-control' command summary for the CLI interface.

func (*SetPCControl) Execute added in v0.8.4 

func (c *SetPCControl) Execute(ctx Context) error

Gets the device ID and enable/disable value from the command line and sends a set-pc-control command to the designated controller.

func (*SetPCControl) Help added in v0.8.4 

func (c *SetPCControl) Help()

Outputs the 'set-pc-control' command help for the CLI interface.

func (*SetPCControl) RequiresConfig added in v0.8.4 

func (c *SetPCControl) RequiresConfig() bool

Returns false - configuration is useful but optional.

func (*SetPCControl) Usage added in v0.8.4 

func (c *SetPCControl) Usage() string

Returns the 'set-pc-control' command parameters for the CLI interface.

type SetTaskList added in v0.7.1 

type SetTaskList struct {
}

func (*SetTaskList) CLI added in v0.7.1 

func (c *SetTaskList) CLI() string

func (*SetTaskList) Description added in v0.7.1 

func (c *SetTaskList) Description() string

func (*SetTaskList) Execute added in v0.7.1 

func (c *SetTaskList) Execute(ctx Context) error

func (*SetTaskList) Help added in v0.7.1 

func (c *SetTaskList) Help()

func (*SetTaskList) RequiresConfig added in v0.7.1 

func (c *SetTaskList) RequiresConfig() bool

Returns false - configuration is useful but optional.

func (*SetTaskList) Usage added in v0.7.1 

func (c *SetTaskList) Usage() string

type SetTime 

type SetTime struct {
}

func (*SetTime) CLI 

func (c *SetTime) CLI() string

func (*SetTime) Description 

func (c *SetTime) Description() string

func (*SetTime) Execute 

func (c *SetTime) Execute(ctx Context) error

func (*SetTime) Help 

func (c *SetTime) Help()

func (*SetTime) RequiresConfig 

func (c *SetTime) RequiresConfig() bool

Returns false - configuration is useful but optional.

func (*SetTime) Usage 

func (c *SetTime) Usage() string

type SetTimeProfile added in v0.7.0 

type SetTimeProfile struct {
}

func (*SetTimeProfile) CLI added in v0.7.0 

func (c *SetTimeProfile) CLI() string

func (*SetTimeProfile) Description added in v0.7.0 

func (c *SetTimeProfile) Description() string

func (*SetTimeProfile) Execute added in v0.7.0 

func (c *SetTimeProfile) Execute(ctx Context) error

func (*SetTimeProfile) Help added in v0.7.0 

func (c *SetTimeProfile) Help()

func (*SetTimeProfile) RequiresConfig added in v0.7.0 

func (c *SetTimeProfile) RequiresConfig() bool

Returns false - configuration is useful but optional.

func (*SetTimeProfile) Usage added in v0.7.0 

func (c *SetTimeProfile) Usage() string

type SetTimeProfiles added in v0.7.0 

type SetTimeProfiles struct {
}

func (*SetTimeProfiles) CLI added in v0.7.0 

func (c *SetTimeProfiles) CLI() string

func (*SetTimeProfiles) Description added in v0.7.0 

func (c *SetTimeProfiles) Description() string

func (*SetTimeProfiles) Execute added in v0.7.0 

func (c *SetTimeProfiles) Execute(ctx Context) error

func (*SetTimeProfiles) Help added in v0.7.0 

func (c *SetTimeProfiles) Help()

func (*SetTimeProfiles) RequiresConfig added in v0.7.0 

func (c *SetTimeProfiles) RequiresConfig() bool

Returns false - configuration is useful but optional.

func (*SetTimeProfiles) Usage added in v0.7.0 

func (c *SetTimeProfiles) Usage() string

type Show 

type Show struct {
}

func (*Show) CLI 

func (c *Show) CLI() string

func (*Show) Description 

func (c *Show) Description() string

func (*Show) Execute 

func (c *Show) Execute(ctx Context) error

func (*Show) Help 

func (c *Show) Help()

func (*Show) RequiresConfig 

func (c *Show) RequiresConfig() bool

Returns true - configuration is not optional for this command to return valid information.

func (*Show) Usage 

func (c *Show) Usage() string

type Version 

type Version struct {
}

Version is a CLI command implementation that displays the CLI version information.

func (*Version) CLI 

func (c *Version) CLI() string

CLI returns the 'version' command line

func (*Version) Description 

func (c *Version) Description() string

Description returns the 'version' command short form help

func (*Version) Execute 

func (c *Version) Execute(ctx Context) error

Execute prints the current 'uhppote' version

func (*Version) Help 

func (c *Version) Help()

Help returns the 'version' command long form help

func (*Version) RequiresConfig 

func (c *Version) RequiresConfig() bool

Returns false - configuration is unused and optional.

func (*Version) Usage 

func (c *Version) Usage() string

Usage returns the string describing the additional options for the 'version' command

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.