History

Filip Bugarski 6483969927 MF-1535 - Add API keys functions to SDK (#1536 ) * Add API keys to sdk. Signed-off-by: Filip Bugarski <filipbugarski@gmail.com> * Add issue key Signed-off-by: Filip Bugarski <filipbugarski@gmail.com> * Fix typo Signed-off-by: Filip Bugarski <filipbugarski@gmail.com> * Fix comments Signed-off-by: Filip Bugarski <filipbugarski@gmail.com> * Remove unused code Signed-off-by: Filip Bugarski <filipbugarski@gmail.com> * Fix typo Signed-off-by: Filip Bugarski <filipbugarski@gmail.com>		2022-01-12 13:24:51 +01:00
..
README.md	MF-1190 - Add pkg for library packages (#1191 )	2020-06-03 15:16:19 +02:00
bootstrap.go	MF 1413 - Use per-service URL in SDK (#1444 )	2021-08-11 16:58:10 +02:00
certs.go	MF 1413 - Use per-service URL in SDK (#1444 )	2021-08-11 16:58:10 +02:00
channels.go	MF 1413 - Use per-service URL in SDK (#1444 )	2021-08-11 16:58:10 +02:00
channels_test.go	MF-1425 - Support external UUIDs for Things and Channels (#1518 )	2021-12-08 12:46:59 +01:00
groups.go	NOISSUE - Remove auth URL from SDK (#1511 )	2021-12-02 13:50:39 +01:00
keys.go	MF-1535 - Add API keys functions to SDK (#1536 )	2022-01-12 13:24:51 +01:00
message.go	MF 1413 - Use per-service URL in SDK (#1444 )	2021-08-11 16:58:10 +02:00
message_test.go	MF 1413 - Use per-service URL in SDK (#1444 )	2021-08-11 16:58:10 +02:00
requests.go	NOISSUE - Remove auth URL from SDK (#1511 )	2021-12-02 13:50:39 +01:00
responses.go	MF-1535 - Add API keys functions to SDK (#1536 )	2022-01-12 13:24:51 +01:00
sdk.go	MF-1535 - Add API keys functions to SDK (#1536 )	2022-01-12 13:24:51 +01:00
sdk_test.go	MF-1190 - Add pkg for library packages (#1191 )	2020-06-03 15:16:19 +02:00
things.go	MF 1413 - Use per-service URL in SDK (#1444 )	2021-08-11 16:58:10 +02:00
things_test.go	MF-1425 - Support external UUIDs for Things and Channels (#1518 )	2021-12-08 12:46:59 +01:00
users.go	MF-1443 - Add policies (#1482 )	2021-10-27 00:38:28 +02:00
users_test.go	MF-1443 - Add policies (#1482 )	2021-10-27 00:38:28 +02:00
version.go	MF 1413 - Use per-service URL in SDK (#1444 )	2021-08-11 16:58:10 +02:00
version_test.go	MF 1413 - Use per-service URL in SDK (#1444 )	2021-08-11 16:58:10 +02:00

README.md

Mainflux Go SDK

Go SDK, a Go driver for Mainflux HTTP API.

Does both system administration (provisioning) and messaging.

Installation

Import "github.com/mainflux/mainflux/sdk/go" in your Go package.

import "github.com/mainflux/mainflux/pkg/sdk/go"```

Then call SDK Go functions to interact with the system.

## API Reference

```go
FUNCTIONS

func NewMfxSDK(host, port string, tls bool) *MfxSDK

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

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

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

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

func (sdk *MfxSDK) CreateThing(data, token string) (string, error)
    CreateThing - creates new thing and generates thing UUID

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

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

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

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

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

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

func (sdk *MfxSDK) DeleteThing(id, token string) error
    DeleteThing - removes thing

func (sdk *MfxSDK) DisconnectThing(thingID, chanID, token string) error
    DisconnectThing - connect thing to a channel

func (sdk mfSDK) SendMessage(chanID, msg, token string) error
    SendMessage - send message on Mainflux channel

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

func (sdk mfSDK) Thing(id, token string) (Thing, error)
    Thing - gets thing by ID

func (sdk mfSDK) Things(token string) ([]Thing, error)
    Things - gets all things

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

func (sdk mfSDK) UpdateThing(thing Thing, token string) error
    UpdateThing - updates thing by ID

func (sdk mfSDK) Version() (string, error)
    Version - server health check