device

Documentation

Index

• func FindDeviceByName(ctx context.Context, name string, getResourceOpts ...GetResourceOpts) (deviceID string, _ error)
• type BaseDevice
  • func MakeBaseDevice(id, name string) BaseDevice
  • func (bd *BaseDevice) GetID() string
  • func (bd *BaseDevice) GetName() string
  • func (bd *BaseDevice) GetSDKClientOptions() []sdk.Option
  • func (bd *BaseDevice) SetID(id string)
• type Device
• type GetResourceOpts
• type Type

Functions

func FindDeviceByName

func FindDeviceByName(ctx context.Context, name string, getResourceOpts ...GetResourceOpts) (deviceID string, _ error)

Types

type BaseDevice

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

func MakeBaseDevice

func MakeBaseDevice(id, name string) BaseDevice

func (*BaseDevice) GetID

func (bd *BaseDevice) GetID() string

func (*BaseDevice) GetName

func (bd *BaseDevice) GetName() string

func (*BaseDevice) GetSDKClientOptions

func (bd *BaseDevice) GetSDKClientOptions() []sdk.Option

func (*BaseDevice) SetID

func (bd *BaseDevice) SetID(id string)

type Device

type Device interface {
	// GetType returns device type
	GetType() Type

	// GetID returns device ID
	GetID() string

	// SetID sets device ID
	SetID(id string)

	// GetName returns device name
	GetName() string

	// GetRetryInterval returns retry interval of the device before retrying provisioning
	GetRetryInterval(attempt int) time.Duration

	// GetDefaultResources returns default device resources
	GetDefaultResources() schema.ResourceLinks

	// GetSDKClientOptions returns options for the SDK client used with this device
	GetSDKClientOptions() []sdk.Option
}

type GetResourceOpts

type GetResourceOpts func(*core.Device) deviceCoap.OptionFunc

type Type

type Type int

const (
	OCF Type = iota
	Bridged
)