https://github.com/mkrainbow/rtio-device-sdk-go
IoT device SDK in Go for RTIO service connectivity.
https://github.com/mkrainbow/rtio-device-sdk-go
embedded iot iot-device remote-control rtio
Last synced: 6 months ago
JSON representation
IoT device SDK in Go for RTIO service connectivity.
- Host: GitHub
- URL: https://github.com/mkrainbow/rtio-device-sdk-go
- Owner: mkrainbow
- License: apache-2.0
- Created: 2024-12-16T11:46:44.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-13T08:32:31.000Z (over 1 year ago)
- Last Synced: 2025-01-13T09:35:47.265Z (over 1 year ago)
- Topics: embedded, iot, iot-device, remote-control, rtio
- Language: Go
- Homepage: https://mkrainbow.com
- Size: 40 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README-CN.md
- License: LICENSE
Awesome Lists containing this project
README
# RTIO设备SDK-Go语言
> 简体中文 | [English](./README.md)
Golang版的物联网设备端SDK，用于连接RTIO服务。
设备也是服务资源的提供者，RTIO采取REST-Like模型，使设备端开发高效和有趣。
## 运行Demo
目前仅在Linux环境下测试。
### 运行RTIO服务端
可通过“Docker”或者“编译源码”方式运行RTIO服务。
#### 编译源码运行RTIO
工具：
- Golang：版本1.21.0或以上。
- GNU Make：建议版本4.3或以上。
- Git.
获取代码。
```sh
git clone https://github.com/mkrainbow/rtio.git
cd rtio
make
```
通过以下命令运行服务，可通过`./out/rtio -h`查看帮助。
```sh
$ ./out/rtio -disable.deviceverify -disable.hubconfiger -log.level info
2024-12-19 17:07:14.198 INF rtio starting ...
```
#### 通过Docker运行RTIO
```sh
$ sudo docker pull registry.cn-guangzhou.aliyuncs.com/rtio/rtio:v0.8.0
v0.8.0: Pulling from rtio/rtio
...
Digest: sha256:...
$ sudo docker run --rm -p 17017:17017 -p 17917:17917 registry.cn-guangzhou.aliyuncs.com/rtio/rtio:v0.8.0
2024-06-03 13:12:23.264 INF rtio starting ...
```
通过以下命令登录容器中，比如查看命令帮助。
```sh
$ sudo docker run -it --rm --entrypoint /bin/sh -p 17017:17017 -p 17917:17917 registry.cn-guangzhou.aliyuncs.com/rtio/rtio:v0.8.0
/home/rainbow $ ./rtio -h
Usage of ./rtio:
...
```
#### 运行设备端Demo
编译Demo。
```sh
git clone https://github.com/mkrainbow/rtio-device-sdk-go.git
mkdir -p out
go build -o out/ github.com/mkrainbow/rtio-device-sdk-go/...
```
```sh
$ ls out/
simple_device simple_device_copost_to_server simple_device_obget simple_device_tls
```
运行`simple_device`。
```sh
./out/simple_device
```
打开另一终端运行`curl`模拟请求到设备。
```sh
$ curl http://localhost:17917/cfa09baa-4913-4ad7-a936-3e26f9671b09 -d '{"method":"copost", "uri":"/rainbow","id":12667,"data":"aGVsbG8="}'
{"id":12667,"fid":0,"code":"OK","data":"d29ybGQ="}
```
其中，"aGVsbG8="为"hello"的base64编码，"d29ybGQ="为"world"的base64编码。可通过以下命令在终端里编解码。
```sh
$ echo -n "hello" | base64 # Encode
aGVsbG8=
$ echo -n "d29ybGQ=" | base64 -d # Decode
world
```
设备端输出：
```sh
$ ./out/simple_device
received [hello] and reply [world]
```
## SDK集成
添加库：
```sh
go get github.com/mkrainbow/rtio-device-sdk-go
```
使用库：
```go
import (
"github.com/mkrainbow/rtio-device-sdk-go/rtio"
)
func main() {
// Connect to rtio service.
session, err := rtio.Connect(context.Background(), *deviceID, *deviceSecret, *serverAddr)
// ...
// Register handler for URI.
session.RegisterPostHandler("/rainbow", func(req []byte) ([]byte, error) {
log.Printf("received [%s] and reply [world]", string(req))
return []byte("world"), nil
})
// Session serve in the background.
session.Serve(context.Background())
// Do other things.
time.Sleep(time.Hour * 8760)
}
```
## API列表
```go
// Connect establishes a connection to a server with the provided device credentials.
func Connect(ctx context.Context, deviceID, deviceSecret, serverAddr string) (*DeviceSession, error)
// ConnectWithLocalAddr establishes a connection with a specified local address. Usually for testing.
func ConnectWithLocalAddr(ctx context.Context, deviceID, deviceSecret, localAddr, serverAddr string) (*DeviceSession, error)
// ConnectWithTLS establishes a TLS-encrypted connection to the server.
func ConnectWithTLS(ctx context.Context, deviceID, deviceSecret, serverAddr, caFile string) (*DeviceSession, error)
// ConnectWithTLSSkipVerify establishes a TLS-encrypted connection, skipping certificate verification.
func ConnectWithTLSSkipVerify(ctx context.Context, deviceID, deviceSecret, serverAddr string) (*DeviceSession, error)
// SetLogConfigs sets the logging configuration (text, json) and log Level (debug, info, warn, error)
func SetLogConfigs(format, level string)
// SetHeartbeatSeconds sets the heartbeat interval in seconds for the device session.
func (*DeviceSession) SetHeartbeatSeconds(n uint16)
// Serve starts the device session and serves requests in background until the context is canceled.
func (*DeviceSession) Serve(ctx context.Context)
// RegisterCoPostHandler registers a handler for CoPOST requests to the specified URI.Not Thread-safe.
func (*DeviceSession) RegisterCoPostHandler(uri string, handler func(req []byte) ([]byte, error)) error
// RegisterObGetHandler registers a handler for ObGET requests to the specified URI.Not Thread-safe.
func (*DeviceSession) RegisterObGetHandler(uri string, handler func(ctx context.Context, req []byte) (<-chan []byte, error)) error
// CoPost Sends a CoPost request to the specified URI with the given payload and timeout.
func (*DeviceSession) CoPost(ctx context.Context, uri string, Req []byte, timeout time.Duration) ([]byte, error)
```