History

Dušan Borovčanin 3f3b42b511 MF-519 - Refine Message (#567 ) * Enable Message JSON mashaling/unmarshaling Update Protobuf generated files. Signed-off-by: Dusan Borovcanin <dusan.borovcanin@mainflux.com> * Update readers and SDK to use Mainflux Message Signed-off-by: Dusan Borovcanin <dusan.borovcanin@mainflux.com> * Fix alignment Signed-off-by: Dusan Borovcanin <dusan.borovcanin@mainflux.com>		2019-02-06 13:57:12 +01:00
..
README.md	NOISSUE - Refactor SDK and things service (#420 )	2018-10-24 10:21:03 +01:00
channels.go	MF-483 - Enable channels and devices corresponding lists in backend (#520 )	2019-01-08 11:53:24 +01:00
channels_test.go	Fix pagination response for empty page (#547 )	2019-01-17 17:31:30 +01:00
message.go	MF-519 - Refine Message (#567 )	2019-02-06 13:57:12 +01:00
message_test.go	MF-475 - Replace increment ID with UUID (#490 )	2018-12-05 13:09:25 +01:00
responses.go	MF-519 - Refine Message (#567 )	2019-02-06 13:57:12 +01:00
sdk.go	MF-519 - Refine Message (#567 )	2019-02-06 13:57:12 +01:00
things.go	MF-483 - Enable channels and devices corresponding lists in backend (#520 )	2019-01-08 11:53:24 +01:00
things_test.go	Fix pagination response for empty page (#547 )	2019-01-17 17:31:30 +01:00
users.go	MF-433 - Add method for reading messages from readers to SDK. (#511 )	2018-12-18 22:04:34 +01:00
users_test.go	MF-417 - Implement SDK tests (#438 )	2018-11-19 21:27:01 +01:00
version.go	MF-433 - Add method for reading messages from readers to SDK. (#511 )	2018-12-18 22:04:34 +01:00
version_test.go	MF-417 - Implement SDK tests (#438 )	2018-11-19 21:27:01 +01: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/sdk/go"

Then call SDK Go functions to interact with the system.

API Reference

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) ConnectThing(thingID, chanID, token string) error
    ConnectThing - connect thing to a channel

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) 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