obix

README

obix 实现WEBStation N4(Niagara)的客户端

1. 名词解释

• WEBStatsion N4: Niagara服务
• DigestScheme: 认证方法(scram)

2. 使用示例

package main 

import (
	"context"
	"log"

	"gitee.com/wqt/obix"
)

func main() {
	var addr, user, pass string
	ctx := context.TODO()
	c, err := obix.NewClient(ctx, addr, user, pass)
	if err != nil {
		log.Fatalf("obix.NewClient error: %s", err)
	}
	b, err := c.Get(ctx, "/obix")
	if err != nil {
		log.Fatalf("obix.Client.Get error: %s", err)
	}
	log.Printf("obix.Client.Get body: %s", b)
}

Documentation

Overview

Package obix 实现WebStation N4的客户端

Index

• Variables
• type Client
  • func NewClient(ctx context.Context, addr, username, password string, opts ...ClientOption) (*Client, error)
  • func (c *Client) Get(ctx context.Context, path string) (obj *types.Obj, err error)
  • func (c *Client) Post(ctx context.Context, path string, v interface{}) (obj *types.Obj, err error)
• type ClientOption
  • func WithLogger(l Logger) ClientOption
  • func WithSkipVerifyTLS(v bool) ClientOption
  • func WithTimeout(d time.Duration) ClientOption
• type Logger

Examples

• Client

Variables

var (
	// ErrSkipRedirect 禁用自动跟随重定向
	ErrSkipRedirect = errors.New("skip redirect")
	// ErrUsernameIsEmpty 用户名不能为空
	ErrUsernameIsEmpty = errors.New("username is empty")
	// ErrPasswordIsEmpty 密码不能为空
	ErrPasswordIsEmpty = errors.New("password is empty")
	// ErrNoData 没有数据返回
	ErrNoData = errors.New("no data received")
)

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client obix协议的客户端, 使用uri点位请求读取或者相关设备的状态等数据

Example

package main

import (
	"context"
	"encoding/xml"
	"log"

	"gitee.com/wqt/obix"
)

func main() {
	var addr, user, pass string
	ctx := context.TODO()
	c, err := obix.NewClient(ctx, addr, user, pass)
	if err != nil {
		log.Fatalf("obix.NewClient error: %s", err)
	}
	obj, err := c.Get(ctx, "/obix")
	if err != nil {
		log.Fatalf("obix.Client.Get error: %s", err)
	}
	if obj != nil {
		b, err := xml.MarshalIndent(obj, "", " ")
		if err != nil {
			log.Fatalf("objx.types.MarshalIndent error: %s", err)
			return
		}
		log.Printf("obix.Client.Get body: %s", b)
	}
}

func NewClient

func NewClient(ctx context.Context, addr, username, password string, opts ...ClientOption) (*Client, error)

NewClient 创建一个WEBStation N4的obix客户端, addr, username和password都是必须的 opts的类型是ClientOption

func (*Client) Get

func (c *Client) Get(ctx context.Context, path string) (obj *types.Obj, err error)

Get 获取指定数据, 如果服务器返回有效数据, 返回obj非空 path不包含如"http://localhost:8000"的主机地址,

func (*Client) Post

func (c *Client) Post(ctx context.Context, path string, v interface{}) (obj *types.Obj, err error)

Post 发送数据, 如果服务器返回有效数据, 返回obj非空 path不包含如"http://localhost:8000"的主机地址,

type ClientOption

type ClientOption func(c *Client)

ClientOption 客户端选项函数

func WithLogger

func WithLogger(l Logger) ClientOption

WithLogger 添加可选的日志

func WithSkipVerifyTLS

func WithSkipVerifyTLS(v bool) ClientOption

WithSkipVerifyTLS 设置跳过tls证书校验

func WithTimeout

func WithTimeout(d time.Duration) ClientOption

type Logger

type Logger interface {
	Printf(format string, v ...interface{})
}