awsiotdev

README

aws-iot-device-sdk-go

Package awsiotdev implements AWS IoT presigned WebSockets dialer for github.com/at-wat/mqtt-go, and AWS IoT features.

Implemented features:

• Device Shadow
• Jobs
• Secure tunneling

Migration guide

• v6

News

• v6.2.0: Go <1.18 support is dropped as aws/aws-sdk-go-v2 dropped them

Contributing

Your contributions like bug reports, bug fixes, feature requests and implementing new features are welcome. Feel free to open a new issue and/or Pull Request.

seqsense/aws-iot-device-sdk-go is developed under GitHub flow. Please open an issue and ask first before actually working on any significant PR (e.g. implementing features). Please refer to the interface design guide.

License

This package is licensed under Apache License Version 2.0.

Documentation

Overview

Package awsiotdev implements AWS IoT presigned WebSockets dialer for github.com/at-wat/mqtt-go, and AWS IoT functionalities.

Index

• func NewDialer(cfg *aws.Config, urlStr string, opts ...mqtt.DialOption) (mqtt.Dialer, error)
• func NewPresignDialer(cfg *aws.Config, endpoint string, opts ...mqtt.DialOption) (mqtt.Dialer, error)
• type Device
  • func New(thingName string, dialer mqtt.Dialer, opts ...mqtt.ReconnectOption) (Device, error)

Functions

func NewDialer

func NewDialer(cfg *aws.Config, urlStr string, opts ...mqtt.DialOption) (mqtt.Dialer, error)

NewDialer creates default dialer for the given URL for AWS IoT. Supported protocols are mqtts and wss (with presigned URL).

func NewPresignDialer

func NewPresignDialer(cfg *aws.Config, endpoint string, opts ...mqtt.DialOption) (mqtt.Dialer, error)

NewPresignDialer returns WebSockets Dialer with AWS v4 presigned URL.

Types

type Device

type Device interface {
	mqtt.ReconnectClient
	ThingName() string
}

Device is an AWS IoT device.

func New

func New(thingName string, dialer mqtt.Dialer, opts ...mqtt.ReconnectOption) (Device, error)

New creates AWS IoT device interface.