SuperMQ Go SDK

Go SDK, a Go driver for SuperMQ HTTP API.

Does both system administration (provisioning) and messaging.

Installation

Import "github.com/absmach/supermq/sdk" in your Go package.

import "github.com/absmach/supermq/pkg/sdk"

You can check SuperMQ CLI as an example of SDK usage.

Then call SDK Go functions to interact with the system.

API Reference

FUNCTIONS

func NewMgxSDK(host, port string, tls bool) *MgxSDK

func (sdk *MgxSDK) Channel(id, token string) (clients.Channel, error)
    Channel - gets channel by ID

func (sdk *MgxSDK) Channels(token string) ([]clients.Channel, error)
    Channels - gets all channels

func (sdk *MgxSDK) Connect(struct{[]string, []string}, token string) error
    Connect - connect clients to channels

func (sdk *MgxSDK) CreateChannel(data, token string) (string, error)
    CreateChannel - creates new channel and generates UUID

func (sdk *MgxSDK) CreateClient(data, token string) (string, error)
    CreateClient - creates new client and generates client UUID

func (sdk *MgxSDK) CreateToken(user, pwd string) (string, error)
    CreateToken - create user token

func (sdk *MgxSDK) CreateUser(user, pwd string) error
    CreateUser - create user

func (sdk *MgxSDK) User(pwd string) (user, error)
    User - gets user

func (sdk *MgxSDK) UpdateUser(user, pwd string) error
    UpdateUser - update user

func (sdk *MgxSDK) UpdatePassword(user, pwd string) error
    UpdatePassword - update user password

func (sdk *MgxSDK) DeleteChannel(id, token string) error
    DeleteChannel - removes channel

func (sdk *MgxSDK) DeleteClient(id, token string) error
    DeleteClient - removes client

func (sdk *MgxSDK) DisconnectClient(clientID, chanID, token string) error
    DisconnectClient - connect client to a channel

func (sdk *MgxSDK) SendMessage(chanID, msg, token string) error
    SendMessage - send message on SuperMQ channel

func (sdk *MgxSDK) SetContentType(ct ContentType) error
    SetContentType - set message content type. Available options are SenML
    JSON, custom JSON and custom binary (octet-stream).

func (sdk *MgxSDK) Client(id, token string) (Client, error)
    Client - gets client by ID

func (sdk *MgxSDK) Clients(token string) ([]Client, error)
    Clients - gets all clients

func (sdk *MgxSDK) UpdateChannel(channel Channel, token string) error
    UpdateChannel - update a channel

func (sdk *MgxSDK) UpdateClient(client Client, token string) error
    UpdateClient - updates client by ID

func (sdk *MgxSDK) Health() (supermq.Health, error)
    Health - clients service health check