gobacnet

README

Bacnet Stack Simple Implements

简单的Bacnet协议实现，主要实现了一些采集功能和基础路由转发功能。

进度

• AI类型的数据点位采集
• 其他类型的数据点位采集

ObjectType	英文名称	中文名称
AI	AnalogInput	模拟输入
AO	AnalogOutput	模拟输出
AV	AnalogValue	模拟值
BI	BinaryInput	二进制输入
BO	BinaryOutput	二进制输出
BV	BinaryValue	二进制值
MI	MultiStateInput	多状态输入
MO	MultiStateOutput	多状态输出
MV	MultiStateValue	多状态值

注意: 目前因为比较紧张的需求，所有实现的功能以需求驱动，并不是完整的bacnet。后续逐步迭代。

Installation

learn some golang if you don't know it first :)

go mod tidy

For usage run:

go mod tidy
cd cli
go run main.go --help

examples

change out the interface and device and so on

whois

go run main.go whois --interface=wlp3s0

go run main.go whois --interface=wlp3s0

read AO

go run main.go read --interface=wlp3s0 --device=202 --objectID=1 --objectType=1 --property=87

write to an AO

go run main.go write --interface=wlp3s0 --device=202 --address=192.168.15.20 --network=4 --mstp=1 --objectID=1 --objectType=1 --property=85 --priority=16 --value=21

write null to @16

go run main.go write --interface=wlp3s0 --device=202 --objectID=1 --objectType=1 --property=85 --priority=16 --null=true

over a bacnet to ms-tp network

• router ip: 192.168.15.20
• bacnet router network number: 4
• bacnet mstp(rs485) mac address (between 0-255): 1

go run main.go read --interface=wlp3s0 --device=202 --address=192.168.15.20 --network=4 --mstp=1 --objectID=1 --objectType=1 --property=85

get device name

go run main.go read --interface=wlp3s0 --device=202 --address=192.168.15.20 --network=4 --mstp=1 --objectID=202 --objectType=8 --property=77

Max APDU Length

Max APDU Length is important on for read/write prop multiple

In the variable "Max APDU Length Accepted" the following are the values that can be returned:

mstp device: 480
ip device: 1476

example same device getting the max APDU

get device MaxApdu length over MSTP will return 480

go run main.go read --interface=wlp3s0 --device=202 --address=192.168.15.20 --network=4 --mstp=1 --objectID=202 --objectType=8 --property=62

get device MaxApdu length and on the same device but over IP will return 1476

go run main.go read --interface=wlp3s0 --device=202 --address=192.168.15.202 --network=0 --mstp=0 --objectID=202 --objectType=8 --property=62

Library

• Who Is
• Iam
• Read Property
• Read Multiple Property (beta)
• Read Range
• Write Property
• Write Property Multiple (beta)
• Who Has
• What Is Network Number (beta)
• Who Is Router To Network (beta)
• Change of Value Notification
• Event Notification
• Subscribe Change of Value
• Atomic Read File
• Atomic Write File

Command Line Interface

• Who Is
• Iam
• Read Property
• Read Multiple Property
• Read Range
• Write Property
• Write Property Multiple
• Who Has
• What Is Network Number
• Who Is Router To Network
• Atomic Read File
• Atomic Write File

testing

Tested on devices

• Johnson Controls (FEC)
• Easy-IO 30p, tested over IP and ms-tp
• Delta Controls
• Reliable Controls
• Honeywell Spyder
• Niagara N4 jace
• Schneider

tested with other bacnet-libs

• bacnet-stack
• bacnet-4j
• bacpypes

This library is heavily based on the BACnet-Stack library originally written by Steve Karg.

• Ported and all credit to alex from https://github.com/alexbeltran/gobacnet
• And ideas from https://github.com/noahtkeller/go-bacnet

example

whois

	bytes := []byte{
		0x81, 0x0b, 0x00, 0x08, // BVLC
		0x01, 0x00, // NPDU
		0x10, 0x08, // APDU
	}

	pc, err := net.ListenPacket("udp4", ":47809")
	if err != nil {
		panic(err)
	}
	defer pc.Close()

	addr, err := net.ResolveUDPAddr("udp4", "255.255.255.255:47808")
	if err != nil {
		panic(err)
	}

	_, err = pc.WriteTo(bytes, addr)
	if err != nil {
		panic(err)
	}
	d := make([]byte, 1)

	a, b, c := pc.ReadFrom(d)
	fmt.Println(a)
	fmt.Println(b)
	fmt.Println(c)

Server

package main

import (
	"fmt"
	"math/rand/v2"
	"time"

	bacnet "github.com/hootrhino/gobacnet"
	"github.com/hootrhino/gobacnet/apdus"
	"github.com/hootrhino/gobacnet/btypes"
)

func main() {
	// cmd.Execute()
	client, err := bacnet.NewClient(&bacnet.ClientBuilder{
		Ip:         "192.168.10.163",
		Port:       47808,
		SubnetCIDR: 24,
		DeviceId:   10,
		VendorId:   10,
		NetWorkId:  10,
		PropertyData: map[uint32][2]btypes.Object{
			1: apdus.NewAIPropertyWithRequiredFields("temp", 1, float32(3.14), "empty"),
			2: apdus.NewAIPropertyWithRequiredFields("humi", 2, float32(77.67), "empty"),
			3: apdus.NewAIPropertyWithRequiredFields("pres", 3, float32(101.11), "empty"),
		},
	})
	if err != nil {
		panic(err)
	}
	fmt.Println("client run success")
	go func() {
		for {
			for i := 1; i <= 3; i++ {
				newValue := rand.Float32()
				client.GetBacnetIPServer().UpdateAIPropertyValue(uint32(i), newValue)
				fmt.Println("Update Value: ", i, ", ", newValue)
			}
			time.Sleep(3 * time.Second)
		}
	}()
	client.ClientRun()
}

Documentation

Index

• Constants
• type BacnetIPServer
  • func NewBacnetIPServer(deviceId uint32, vendorId uint32, netWorkId uint16, ...) *BacnetIPServer
  • func (s *BacnetIPServer) GetObjectProperties(ObjectInstanceId uint32) (btypes.MultiplePropertyData, error)
  • func (s *BacnetIPServer) UpdateAIPropertyValue(InstanceId uint32, value interface{}) error
• type Client
  • func NewClient(cb *ClientBuilder) (Client, error)
• type ClientBuilder
• type SetBroadcastType
• type WhoIsOpts

Constants

const ArrayAll = 0xFFFFFFFF

ArrayAll is used when reading/writing to a property to read/write the entire array

Types

type BacnetIPServer

type BacnetIPServer struct {
	PropertyData map[uint32][2]btypes.Object // 点位, 后续对外提供的服务就是这个
	// contains filtered or unexported fields
}

Server Ip模式

func NewBacnetIPServer

func NewBacnetIPServer(
	deviceId uint32,
	vendorId uint32,
	netWorkId uint16,
	PropertyData map[uint32][2]btypes.Object,
) *BacnetIPServer

func (*BacnetIPServer) GetObjectProperties

func (s *BacnetIPServer) GetObjectProperties(ObjectInstanceId uint32) (btypes.MultiplePropertyData, error)

根据Bacnet请求查点位里面的数据

func (*BacnetIPServer) UpdateAIPropertyValue

func (s *BacnetIPServer) UpdateAIPropertyValue(InstanceId uint32, value interface{}) error

更新值

type Client

type Client interface {
	io.Closer
	ClientRun()
	ClientClose(closeLogs bool) error
	StartPoll(ctx context.Context)
	StopPoll()
	WhoIs(wh *WhoIsOpts) ([]btypes.Device, error)
	WhatIsNetworkNumber() []*btypes.Address
	IAm(dest btypes.Address, iam btypes.IAm) error
	WhoIsRouterToNetwork() (resp *[]btypes.Address)
	Objects(dev btypes.Device) (btypes.Device, error)
	ReadProperty(dest btypes.Device, rp btypes.PropertyData) (btypes.PropertyData, error)
	ReadMultiProperty(dev btypes.Device, rp btypes.MultiplePropertyData) (btypes.MultiplePropertyData, error)
	WriteProperty(dest btypes.Device, wp btypes.PropertyData) error
	WriteMultiProperty(dev btypes.Device, wp btypes.MultiplePropertyData) error
	SetLogger(*logrus.Logger) error
	GetLogger() *logrus.Logger
	GetBacnetIPServer() *BacnetIPServer
}

func NewClient

func NewClient(cb *ClientBuilder) (Client, error)

NewClient creates a new client with the given interface and

type ClientBuilder

type ClientBuilder struct {
	DataLink     datalink.DataLink
	Interface    string
	Ip           string
	Port         int
	SubnetCIDR   int
	MaxPDU       uint16
	NetWorkId    uint16
	DeviceId     uint32
	VendorId     uint32
	PropertyData map[uint32][2]btypes.Object
}

type SetBroadcastType

type SetBroadcastType struct {
	Set     bool
	BacFunc btypes.BacFunc
}

type WhoIsOpts

type WhoIsOpts struct {
	Low             int    `json:"low"`
	High            int    `json:"high"`
	GlobalBroadcast bool   `json:"global_broadcast"`
	NetworkNumber   uint16 `json:"network_number"`
}