mirror of
https://github.com/mainflux/mainflux.git
synced 2025-04-27 13:48:49 +08:00
e6e9d22133
* initial commit Signed-off-by: aryan <aryangodara03@gmail.com> * remove unused variables. Signed-off-by: aryan <aryangodara03@gmail.com> * removed temporarily created file. Signed-off-by: aryan <aryangodara03@gmail.com> * Fix failing CI Signed-off-by: aryan <aryangodara03@gmail.com> * Fix thing_test failing cases. Signed-off-by: aryan <aryangodara03@gmail.com> * Remove dead code, debug statements, and add comments. Signed-off-by: aryan <aryangodara03@gmail.com> * Extract errors to separate file. Signed-off-by: aryan <aryangodara03@gmail.com> * Updated things/api/http tests Signed-off-by: aryan <aryangodara03@gmail.com> * Created custom SDK error. Signed-off-by: aryan <aryangodara03@gmail.com> * Changed to using CheckError. All tests passing. Signed-off-by: aryan <aryangodara03@gmail.com> * Replace error interface with errors.SDKError interface. Signed-off-by: aryan <aryangodara03@gmail.com> * Fix failing CI. Signed-off-by: aryan <aryangodara03@gmail.com> * Remove unused sdk errors. Signed-off-by: aryan <aryangodara03@gmail.com> * Change SDKError to error in internal function of sdk package. Signed-off-by: aryan <aryangodara03@gmail.com> * Remove unused error. Signed-off-by: aryan <aryangodara03@gmail.com> * Remove encodeError. All tests working. Signed-off-by: aryan <aryangodara03@gmail.com> * Rename sdkerr vars, convert common strings to constants. Signed-off-by: aryan <aryangodara03@gmail.com> * Change checkerror to take error instead of string. Signed-off-by: aryan <aryangodara03@gmail.com> * Remove unused errors, and removed errfailedwhitelist wrap. Signed-off-by: aryan <aryangodara03@gmail.com> * Removed unused errors, and remove errors.go since it only had a repeated error from errors package Signed-off-by: aryan <aryangodara03@gmail.com> * Remove unused errors. Signed-off-by: aryan <aryangodara03@gmail.com> * Update sdk_error. Signed-off-by: aryan <aryangodara03@gmail.com> * Used function to reduce code for sending and receiving requests. Signed-off-by: aryan <aryangodara03@gmail.com> * Added function sendrequestandgetheadersorerror. Signed-off-by: aryan <aryangodara03@gmail.com> * sdk_error updated. Signed-off-by: aryan <aryangodara03@gmail.com> * Updated function names to processRequest. Signed-off-by: aryan <aryangodara03@gmail.com> * Made errors internal, fixed typo in http. Signed-off-by: aryan <aryangodara03@gmail.com> * Remove empty line. Signed-off-by: aryan <aryangodara03@gmail.com> * merged proceessBody and processHeaders functions in sdk. Signed-off-by: aryan <aryangodara03@gmail.com> * remove sendThingRequest function. Signed-off-by: aryan <aryangodara03@gmail.com> * changed processRequest signature Signed-off-by: aryan <aryangodara03@gmail.com> * changed processRequest signature, changed error names. Signed-off-by: aryan <aryangodara03@gmail.com> Signed-off-by: aryan <aryangodara03@gmail.com> Co-authored-by: Dušan Borovčanin <dusan.borovcanin@mainflux.com>
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) Health() (mainflux.Health, error)
Health - things service health check