Skip to content

Implementation of Texas Instruments Unified Network Processor Interface frame protocol in Go.

License

Notifications You must be signed in to change notification settings

shimmeringbee/unpi

Repository files navigation

Shimmering Bee: UNPI

license standard-readme compliant Actions Status

Implementation of Texas Instruments Unified Network Processor Interface frame protocol in Go.

Table of Contents

Background

UNPI is used by Texas Instruments for communicating with many of their Network Processor microcontrollers, specifically this library was written to support the CC253X series of Zigbee sniffers flashed with the zigbee2mqtt Z-Stack coordinator firmware.

More information about UNPI is available from Texas Instruments directly.

Another implementation of UNPI exists for Golang, it did hold no license for a period and the author could not be contacted. This has been rectified, so it may be of interest you. This is a complete reimplementation of the library, however it is likely there will be strong coincidences due to Golang standards.

Install

Add an import and most IDEs will go get automatically, if it doesn't go build will fetch.

import "github.com/shimmeringbee/unpi"

Usage

This libraries API is unstable and should not yet be relied upon.

Writing

serialPort := // UART port providing a Writer

// Construct a SysReset
frame := &Frame{
    MessageType: AREQ,
    Subsystem:   SYS,
    CommandID:   0x00,
    Payload:     []byte { 0x00 },
}

// Send Frame to CC253X, blocking operation
err := unpi.Write(serialPort, frame)

Reading

serialPort := // UART port providing a Reader

// Read from CC253X, blocking operation
frame, err := unpi.Read(serialPort)

if err != nil {
    // Handle Error
}

// Use frame
fmt.Printf("%+v\n", frame)

Maintainers

@pwood

Contributing

Feel free to dive in! Open an issue or submit PRs.

All Shimmering Bee projects follow the Contributor Covenant Code of Conduct.

License

Copyright 2019-2020 Shimmering Bee Contributors

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

About

Implementation of Texas Instruments Unified Network Processor Interface frame protocol in Go.

Topics

Resources

License

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages