client

Documentation

Overview

Package client is for communication with the EdgeX Foundry platform.

Index

• Variables
• func GetDevice(device string) (*models.Device, error)
• func GetDeviceCommandForDeviceAndCommand(device, command string) (models.CommandResponse, error)
• func GetDeviceProfileForDevice(device string) (*models.DeviceProfile, error)
• func GetDevices() ([]*models.Device, error)
• func GetLastReadingForDeviceAndResource(device, resource string) (*models.Reading, error)
• func GetValueDescriptorsForDevice(device string) ([]*models.ValueDescriptor, error)
• func PutDeviceCommandForDeviceAndCommand(device, command string, payload models.CommandPayload) (models.CommandResponse, error)
• type ResponseError
  • func (e *ResponseError) Error() string

Variables

var (
	// ClientCoreData is the client for core data.
	ClientCoreData *resty.Client
	// ClientCoreMetaData is the client for core metadata.
	ClientCoreMetaData *resty.Client
	// ClientCoreCommand is the client for core command.
	ClientCoreCommand *resty.Client
)

Functions

func GetDevice

func GetDevice(device string) (*models.Device, error)

GetDevice returns the device for the given name.

func GetDeviceCommandForDeviceAndCommand

func GetDeviceCommandForDeviceAndCommand(device, command string) (models.CommandResponse, error)

GetDeviceCommandForDeviceAndCommand executes a GET-command on the given device and returns the response.

func GetDeviceProfileForDevice

func GetDeviceProfileForDevice(device string) (*models.DeviceProfile, error)

GetDeviceProfileForDevice returns the deviceprofile for the given device.

func GetDevices

func GetDevices() ([]*models.Device, error)

GetDevices returns all devices.

func GetLastReadingForDeviceAndResource

func GetLastReadingForDeviceAndResource(device, resource string) (*models.Reading, error)

GetLastReadingForDeviceAndResource returns the last reading of the devices resource.

func GetValueDescriptorsForDevice

func GetValueDescriptorsForDevice(device string) ([]*models.ValueDescriptor, error)

GetValueDescriptorsForDevice returns a list of all valuedescriptors asociated with the device.

func PutDeviceCommandForDeviceAndCommand

func PutDeviceCommandForDeviceAndCommand(device, command string, payload models.CommandPayload) (models.CommandResponse, error)

PutDeviceCommandForDeviceAndCommand executes a PUT-command on the given device and returns it response.

Types

type ResponseError

type ResponseError struct {
	Code    int
	Message string
}

ResponseError is the representation of a response error.

func (*ResponseError) Error

func (e *ResponseError) Error() string