command

package

v1.0.17 Latest Latest Go to latest Published: Mar 15, 2024 License: Apache-2.0 Imports: 31 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/SENERGY-Platform/device-command

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func StartKafkaCacheInvalidator(ctx context.Context, config configuration.Config) (err error)
type BatchRequest
- func (this BatchRequest) Validate() error
type BatchResultElement
type Command
- func New(ctx context.Context, config configuration.Config) (cmd *Command, err error)
- func NewWithFactories(ctx context.Context, config configuration.Config, ...) (cmd *Command, err error)
type CommandMessage
- func (this CommandMessage) Hash() string
- func (this CommandMessage) Validate() error
type SubCommand

Constants ¶

This section is empty.

Variables ¶

View Source

var ErrMissingLastValue = errors.New("missing last value in mgw-last-value")

View Source

var ErrMissingLastValueCode = 513 //custom code to signify missing last-value in mgw-last-value

Functions ¶

func StartKafkaCacheInvalidator ¶ added in v1.0.3

func StartKafkaCacheInvalidator(ctx context.Context, config configuration.Config) (err error)

Types ¶

type BatchRequest ¶

type BatchRequest []CommandMessage

func (BatchRequest) Validate ¶

func (this BatchRequest) Validate() error

type BatchResultElement ¶

type BatchResultElement struct {
	StatusCode int         `json:"status_code"`
	Message    interface{} `json:"message"`
}

type Command ¶

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

func New ¶

func New(ctx context.Context, config configuration.Config) (cmd *Command, err error)

func NewWithFactories ¶

func NewWithFactories(ctx context.Context, config configuration.Config, comFactory interfaces.ComFactory, marshallerFactory interfaces.MarshallerFactory, iotFactory interfaces.IotFactory, timescaleFactory interfaces.TimescaleFactory) (cmd *Command, err error)

func (*Command) Batch ¶

func (this *Command) Batch(token auth.Token, batch BatchRequest, timeout string, preferEventValue bool) []BatchResultElement

func (*Command) Command ¶

func (this *Command) Command(token auth.Token, cmd CommandMessage, timeout string, preferEventValue bool) (code int, resp interface{})

func (*Command) DeviceCommand ¶

func (this *Command) DeviceCommand(token auth.Token, deviceId string, serviceId string, functionId string, aspectId string, input interface{}, timeout string, preferEventValue bool, batch *eventbatch.EventBatch, characteristicId string) (code int, resp interface{})

func (*Command) ErrorMessageHandler ¶

func (this *Command) ErrorMessageHandler(message messages.ProtocolMsg) error

func (*Command) GetEventBatch ¶

func (this *Command) GetEventBatch(token auth.Token, tasks BatchRequest, preferEventValue bool) (batch *eventbatch.EventBatch, err error)

func (*Command) GetLastEventValue ¶

func (this *Command) GetLastEventValue(token auth.Token, device model.Device, service model.Service, protocol model.Protocol, characteristicId string, functionId string, aspect model.AspectNode, eventBatch *eventbatch.EventBatch, timeout time.Duration) (code int, result interface{})

func (*Command) GetMetricsHttpHandler ¶ added in v1.0.11

func (this *Command) GetMetricsHttpHandler() *metrics.Metrics

func (*Command) GetSubTasks ¶

func (this *Command) GetSubTasks(token string, deviceGroupId string, functionId string, aspectId string, deviceClassId string, input interface{}) (result []SubCommand, err error)

func (*Command) GroupCommand ¶

func (this *Command) GroupCommand(token auth.Token, groupId string, functionId string, aspectId string, deviceClassId string, input interface{}, timeout string, preferEventValue bool, batch *eventbatch.EventBatch, characteristicId string) (code int, resp interface{})

func (*Command) HandleTaskResponse ¶

func (this *Command) HandleTaskResponse(message messages.ProtocolMsg) (err error)

type CommandMessage ¶

type CommandMessage struct {
	FunctionId string      `json:"function_id"`         //mandatory
	AspectId   string      `json:"aspect_id,omitempty"` //optional
	Input      interface{} `json:"input"`

	//device command
	DeviceId  string `json:"device_id,omitempty"`
	ServiceId string `json:"service_id,omitempty"`

	//group command
	GroupId string `json:"group_id,omitempty"`

	DeviceClassId    string `json:"device_class_id,omitempty"`
	CharacteristicId string `json:"characteristic_id,omitempty"`
}

func (CommandMessage) Hash ¶

func (this CommandMessage) Hash() string

func (CommandMessage) Validate ¶

func (this CommandMessage) Validate() error

type SubCommand ¶

type SubCommand struct {
	FunctionId string `json:"function_id"` //mandatory
	AspectId   string
	Input      interface{} `json:"input"`
	DeviceId   string      `json:"device_id,omitempty"`
	ServiceId  string      `json:"service_id,omitempty"`
}

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
dependencies
impl/cloud
impl/mgw
impl/mgw/marshaller
impl/mgw/mqtt
interfaces
eventbatch
metrics

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