types

package

v1.4.0 Latest Latest Go to latest Published: Jun 9, 2020 License: GPL-3.0 Imports: 7 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/gochik/chik

Links

Open Source Insights

Documentation ¶

Index ¶

func Decode(input, output interface{}, hooks ...mapstructure.DecodeHookFunc) error
func StringInterfaceToJsonRawMessage(sourceType, targetType reflect.Type, sourceData interface{}) (interface{}, error)
type Action
type Command
- func NewCommand(t CommandType, data interface{}) *Command
- func (c *Command) String() string
type CommandType
- func (i CommandType) String() string
type DigitalCommand
type EnabledDays
type SimpleCommand
type Status
type VersionIndication

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Decode ¶

func Decode(input, output interface{}, hooks ...mapstructure.DecodeHookFunc) error

func StringInterfaceToJsonRawMessage ¶

func StringInterfaceToJsonRawMessage(sourceType, targetType reflect.Type, sourceData interface{}) (interface{}, error)

Types ¶

type Action ¶

type Action uint16

Action is an enum of all the possible commands

const (
	SET    Action = iota // Turn on/activate something
	RESET                // Turn off/deactivate something
	TOGGLE               // Toggle something from on/activated to off/deactivated
	PUSH                 // Used to define actions shuch as the one of pushing a button
	GET                  // Retrieve a value
)

Available actions

type Command ¶

type Command struct {
	Type CommandType     `json:"type"`
	Data json.RawMessage `json:"data"`
}

Command is the root object in every message

func NewCommand ¶

func NewCommand(t CommandType, data interface{}) *Command

NewCommand creates a command given a type and his content

func (*Command) String ¶

func (c *Command) String() string

type CommandType ¶

type CommandType uint8

CommandType represent the type of the current message

const (
	HeartbeatType CommandType = iota
	DigitalCommandType
	StatusSubscriptionCommandType
	StatusNotificationCommandType
	VersionRequestCommandType
	VersionReplyCommandType

	// private commands (sent on the loopback address)
	StatusUpdateCommandType
	IODeviceStatusChangedCommandType

	// special command types
	AnyIncomingCommandType
	AnyOutgoingCommandType
)

Command types types used in various plugins

func (CommandType) String ¶

func (i CommandType) String() string

type DigitalCommand ¶

type DigitalCommand struct {
	Action      Action `json:"action,int"`
	ApplianceID string
}

DigitalCommand used to instruct the appliance to execute a Command on a gpio pin

type EnabledDays ¶

type EnabledDays uint16

EnabledDays days on which a TimedCommand is enabled used as binary flag

type SimpleCommand ¶

type SimpleCommand struct {
	Action Action `json:"action,int"`
}

SimpleCommand is used to send a basic request regarding the whole system

type Status ¶

type Status map[string]interface{}

Status is the response to a status request Command the key is the handler name value can be anything

type VersionIndication ¶

type VersionIndication struct {
	CurrentVersion   string
	AvailableVersion string
}

VersionIndication returns info about the current version and the optional update available

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL