command

Documentation

Overview

Package command provides a client for integration with the core-command service.

Index

• type CommandClient
  • func NewCommandClient(params types.EndpointParams, m interfaces.Endpointer) CommandClient

Types

type CommandClient

type CommandClient interface {
	// Get issues a GET command targeting the specified device, using the specified command id
	Get(deviceId string, commandId string, ctx context.Context) (string, error)
	// Put issues a PUT command targeting the specified device, using the specified command id
	Put(deviceId string, commandId string, body string, ctx context.Context) (string, error)
	// GetDeviceCommandByNames issues a GET command targeting the specified device, using the specified device and command name
	GetDeviceCommandByNames(deviceName string, commandName string, ctx context.Context) (string, error)
	// PutDeviceCommandByNames issues a PUT command targeting the specified device, using the specified device and command names
	PutDeviceCommandByNames(deviceName string, commandName string, body string, ctx context.Context) (string, error)
}

The CommandClient interface defines interactions with the EdgeX Core Command microservice.

func NewCommandClient

func NewCommandClient(params types.EndpointParams, m interfaces.Endpointer) CommandClient

NewCommandClient creates an instance of CommandClient