device

Documentation

Index

• Constants
• type KeyPair
• type Payload
• type Shadow
  • func (s Shadow) String() string
• type ShadowError
• type Thing
  • func NewThingFromFiles(keyPair KeyPair, awsEndpoint string, thingName ThingName) (*Thing, error)
  • func NewThingFromStrings(cert string, key string, awsEndpoint string, thingName ThingName) (*Thing, error)
  • func (t *Thing) DeleteThingShadow() error
  • func (t *Thing) Disconnect()
  • func (t *Thing) GetNextJob() (Payload, error)
  • func (t *Thing) GetThingShadow() (Shadow, error)
  • func (t *Thing) ListenForJobs() (chan Payload, error)
  • func (t *Thing) PublishToCustomTopic(payload Payload, topic string) error
  • func (t *Thing) SubscribeForCustomTopic(topic string) (chan Payload, error)
  • func (t *Thing) SubscribeForThingShadowChanges() (chan Shadow, chan ShadowError, error)
  • func (t Thing) UnsubscribeFromCustomTopic(topic string) error
  • func (t *Thing) UnsubscribeFromJobs() error
  • func (t *Thing) UpdateThingShadow(payload Shadow) error
  • func (t *Thing) UpdateThingShadowDocument(payload Shadow) error
• type ThingName

Constants

const ROOT_PEM = `` /* 1187-byte string literal not displayed */

Amazon Root CA for IoT Core - Subject to change (but likely not often) https://www.amazontrust.com/repository/AmazonRootCA1.pem

Types

type KeyPair

type KeyPair struct {
	PrivateKeyPath    string
	CertificatePath   string
	CACertificatePath string
}

KeyPair the structure contains the path to the AWS MQTT credentials

type Payload

type Payload []byte

Payload device data

type Shadow

type Shadow []byte

Shadow device shadow data

func (Shadow) String

func (s Shadow) String() string

String converts the Shadow to string

type ShadowError

type ShadowError = Shadow

ShadowError represents the model for handling the errors occurred during updating the device shadow

type Thing

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

Thing a structure for working with the AWS IoT device shadows

func NewThingFromFiles

func NewThingFromFiles(keyPair KeyPair, awsEndpoint string, thingName ThingName) (*Thing, error)

NewThingFromFiles returns a new instance of Thing

func NewThingFromStrings

func NewThingFromStrings(cert string, key string, awsEndpoint string, thingName ThingName) (*Thing, error)

NewThingFromStrings returns a new instance of Thing

func (*Thing) DeleteThingShadow

func (t *Thing) DeleteThingShadow() error

DeleteThingShadow publishes a message to remove the device's shadow and waits for the result. In case shadow delete was rejected the method will return error

func (*Thing) Disconnect

func (t *Thing) Disconnect()

Disconnect terminates the MQTT connection between the client and the AWS server. Recommended to use in defer to avoid connection leaks.

func (*Thing) GetNextJob

func (t *Thing) GetNextJob() (Payload, error)

func (*Thing) GetThingShadow

func (t *Thing) GetThingShadow() (Shadow, error)

GetThingShadow returns the current thing shadow

func (*Thing) ListenForJobs

func (t *Thing) ListenForJobs() (chan Payload, error)

ListenForJobs is a helper function that subscribes to the topic responsible for notifying on IoT Core Jobs

func (*Thing) PublishToCustomTopic

func (t *Thing) PublishToCustomTopic(payload Payload, topic string) error

PublishToCustomTopic publishes an async message to the custom topic.

func (*Thing) SubscribeForCustomTopic

func (t *Thing) SubscribeForCustomTopic(topic string) (chan Payload, error)

SubscribeForCustomTopic subscribes for the custom topic and returns the channel with the topic messages.

func (*Thing) SubscribeForThingShadowChanges

func (t *Thing) SubscribeForThingShadowChanges() (chan Shadow, chan ShadowError, error)

SubscribeForThingShadowChanges subscribes for the device shadow update topic and returns two channels: shadow and shadow error. The shadow channel will handle all accepted device shadow updates. The shadow error channel will handle all rejected device shadow updates

func (Thing) UnsubscribeFromCustomTopic

func (t Thing) UnsubscribeFromCustomTopic(topic string) error

UnsubscribeFromCustomTopic terminates the subscription to the custom topic. The specified topic argument will be prepended by a prefix "$aws/things/<thing_name>"

func (*Thing) UnsubscribeFromJobs

func (t *Thing) UnsubscribeFromJobs() error

func (*Thing) UpdateThingShadow

func (t *Thing) UpdateThingShadow(payload Shadow) error

UpdateThingShadow publishes an async message with new thing shadow

func (*Thing) UpdateThingShadowDocument

func (t *Thing) UpdateThingShadowDocument(payload Shadow) error

UpdateThingShadowDocument publishes an async message with new thing shadow document

type ThingName

type ThingName = string

ThingName the name of the AWS IoT device representation