mqtt

package

v1.0.1 Latest Latest Go to latest Published: Jun 17, 2022 License: MIT Imports: 6 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/tuffnerdstuff/hauk-snitch

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
type Client
- func New(config Config) *Client
- func (t *Client) Connect()
- func (t *Client) Disconnect()
type Config
type Message

Constants ¶

View Source

const ParamAccuracy string = "acc"

ParamAccuracy is the key for the parameter "accuracy"

View Source

const ParamAltitude string = "alt"

ParamAltitude is the key for the parameter "altitude"

View Source

const ParamLatitude string = "lat"

ParamLatitude is the key for the parameter "latitude"

View Source

const ParamLongitude string = "lon"

ParamLongitude is the key for the parameter "longitude"

View Source

const ParamTime string = "tst"

ParamTime is the key for the parameter "time"

View Source

const ParamTrigger string = "t"

ParamTrigger is the key for the parameter "trigger"

View Source

const ParamType string = "_type"

ParamType is the key for the parameter "type"

View Source

const ParamVelocity string = "vel"

ParamVelocity is the key for the parameter "velocity"

View Source

const TriggerManual string = "u"

TriggerManual is a value for the parameter "trigger". It means that the location has been sent by the user manually.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Client ¶

type Client struct {
	Messages chan Message
	// contains filtered or unexported fields
}

Client provides an mqtt client

func New ¶

func New(config Config) *Client

New returns an instance of an mqtt client

func (*Client) Connect ¶

func (t *Client) Connect()

Connect connects to mqtt broker using the given config

func (*Client) Disconnect ¶

func (t *Client) Disconnect()

Disconnect closes the Messages channel and disconnects the mqtt client

type Config ¶

type Config struct {
	Host        string
	Port        int
	Topic       string
	User        string
	Password    string
	IsTLS       bool
	IsAnonymous bool
}

Config holds configuration for MqttClient

type Message ¶

type Message struct {
	Topic string
	Body  map[string]interface{}
}

Message is an MQTT message consisting of a topic and a body (map)

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL