clients

Documentation

Index

• Constants
• func NewCommandClient(messageBus messaging.MessageClient, topics map[string]string, ...) (interfaces.CommandClient, error)
• type CommandClient
  • func (c *CommandClient) AllDeviceCoreCommands(ctx context.Context, offset int, limit int) (responses.MultiDeviceCoreCommandsResponse, edgexErr.EdgeX)
  • func (c *CommandClient) DeviceCoreCommandsByDeviceName(ctx context.Context, deviceName string) (responses.DeviceCoreCommandResponse, edgexErr.EdgeX)
  • func (c *CommandClient) IssueGetCommandByName(ctx context.Context, deviceName string, commandName string, dsPushEvent string, ...) (*responses.EventResponse, edgexErr.EdgeX)
  • func (c *CommandClient) IssueGetCommandByNameWithQueryParams(ctx context.Context, deviceName string, commandName string, ...) (*responses.EventResponse, edgexErr.EdgeX)
  • func (c *CommandClient) IssueSetCommandByName(ctx context.Context, deviceName string, commandName string, ...) (commonDTO.BaseResponse, edgexErr.EdgeX)
  • func (c *CommandClient) IssueSetCommandByNameWithObject(ctx context.Context, deviceName string, commandName string, ...) (commonDTO.BaseResponse, edgexErr.EdgeX)

Constants

const (
	QueryRequestTopicPrefix   = "QueryRequestTopicPrefix"
	QueryResponseTopic        = "QueryResponseTopic"
	CommandRequestTopicPrefix = "CommandRequestTopicPrefix"
	CommandResponseTopic      = "CommandResponseTopic"
)

Functions

func NewCommandClient

func NewCommandClient(messageBus messaging.MessageClient, topics map[string]string, timeout time.Duration) (interfaces.CommandClient, error)

Types

type CommandClient

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

func (*CommandClient) AllDeviceCoreCommands

func (c *CommandClient) AllDeviceCoreCommands(ctx context.Context, offset int, limit int) (responses.MultiDeviceCoreCommandsResponse, edgexErr.EdgeX)

func (*CommandClient) DeviceCoreCommandsByDeviceName

func (c *CommandClient) DeviceCoreCommandsByDeviceName(ctx context.Context, deviceName string) (responses.DeviceCoreCommandResponse, edgexErr.EdgeX)

func (*CommandClient) IssueGetCommandByName

func (c *CommandClient) IssueGetCommandByName(ctx context.Context, deviceName string, commandName string, dsPushEvent string, dsReturnEvent string) (*responses.EventResponse, edgexErr.EdgeX)

func (*CommandClient) IssueGetCommandByNameWithQueryParams

func (c *CommandClient) IssueGetCommandByNameWithQueryParams(ctx context.Context, deviceName string, commandName string, queryParams map[string]string) (*responses.EventResponse, edgexErr.EdgeX)

func (*CommandClient) IssueSetCommandByName

func (c *CommandClient) IssueSetCommandByName(ctx context.Context, deviceName string, commandName string, settings map[string]string) (commonDTO.BaseResponse, edgexErr.EdgeX)

func (*CommandClient) IssueSetCommandByNameWithObject

func (c *CommandClient) IssueSetCommandByNameWithObject(ctx context.Context, deviceName string, commandName string, settings map[string]any) (commonDTO.BaseResponse, edgexErr.EdgeX)