models

package

v0.0.0-...-947ae56 Latest Latest Go to latest Published: May 26, 2021 License: MIT Imports: 12 Imported by: 2

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/omzlo/nocand

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func NodeCacheFile(file *helpers.FilePath)
func NodeCacheLoad() error
func NodeCacheLookup(udid Udid8) nocan.NodeId
func NodeCacheReverseLookup(node_id nocan.NodeId) bool
func NodeCacheSave() error
func NodeCacheSetEntry(udid Udid8, node_id nocan.NodeId) bool
type Channel
- func (c *Channel) GetContent() []byte
- func (c *Channel) SetContent(content []byte) bool
- func (c *Channel) String() string
- func (c *Channel) Touch()
type ChannelCollection
- func NewChannelCollection() *ChannelCollection
- func (cc *ChannelCollection) Each(fn func(*Channel))
- func (cc *ChannelCollection) EachOrdered(fn func(*Channel))
- func (cc *ChannelCollection) Find(channelId nocan.ChannelId) *Channel
- func (cc *ChannelCollection) Lookup(channelName string) *Channel
- func (cc *ChannelCollection) Register(channelName string) (*Channel, error)
- func (cc *ChannelCollection) Unregister(channel *Channel) bool
type JsonCacheEntry
type Node
- func NewNode(id nocan.NodeId, udid Udid8, fw_version uint8) *Node
- func (n *Node) ExpandAttributes(s string) string
- func (n *Node) GetAttribute(attr string) string
- func (n *Node) SetAttribute(attr string, value string)
- func (n *Node) String() string
- func (n *Node) Touch()
type NodeCollection
- func NewNodeCollection() *NodeCollection
- func (nc *NodeCollection) Clear()
- func (nc *NodeCollection) Each(cb func(node *Node))
- func (nc *NodeCollection) Find(id nocan.NodeId) *Node
- func (nc *NodeCollection) Lookup(udid Udid8) *Node
- func (nc *NodeCollection) Register(udid Udid8, fw_version uint8) (*Node, error)
- func (nc *NodeCollection) Unregister(node *Node) bool
type NodeState
- func (ns NodeState) MarshalJSON() ([]byte, error)
- func (ns NodeState) String() string
type Udid8
- func CreateUdid8(b []byte) Udid8
- func (id Udid8) DecodeString(s string) error
- func (id Udid8) MarshalJSON() ([]byte, error)
- func (id Udid8) String() string

Constants ¶

View Source

const DEFAULT_EXPECT_TIMEOUT = 3 * time.Second

Variables ¶

View Source

var NodeStateStrings = [NodeStateCount]string{
	"unknown",
	"connecting",
	"connected",
	"bootloader",
	"running",
	"programming",
	"unresponsive",
}

View Source

var NullUdid8 = Udid8{0, 0, 0, 0, 0, 0, 0, 0}

Functions ¶

func NodeCacheFile ¶

func NodeCacheFile(file *helpers.FilePath)

func NodeCacheLoad ¶

func NodeCacheLoad() error

func NodeCacheLookup ¶

func NodeCacheLookup(udid Udid8) nocan.NodeId

func NodeCacheReverseLookup ¶

func NodeCacheReverseLookup(node_id nocan.NodeId) bool

func NodeCacheSave ¶

func NodeCacheSave() error

func NodeCacheSetEntry ¶

func NodeCacheSetEntry(udid Udid8, node_id nocan.NodeId) bool

Types ¶

type Channel ¶

type Channel struct {
	Id        nocan.ChannelId
	Name      string
	Value     []byte
	UpdatedAt time.Time
}

Channel

func (*Channel) GetContent ¶

func (c *Channel) GetContent() []byte

func (*Channel) SetContent ¶

func (c *Channel) SetContent(content []byte) bool

func (*Channel) String ¶

func (c *Channel) String() string

func (*Channel) Touch ¶

func (c *Channel) Touch()

type ChannelCollection ¶

type ChannelCollection struct {
	Mutex  sync.RWMutex
	ById   map[nocan.ChannelId]*Channel
	ByName map[string]*Channel
	TopId  nocan.ChannelId
}

ChannelCollection

func NewChannelCollection ¶

func NewChannelCollection() *ChannelCollection

func (*ChannelCollection) Each ¶

func (cc *ChannelCollection) Each(fn func(*Channel))

func (*ChannelCollection) EachOrdered ¶

func (cc *ChannelCollection) EachOrdered(fn func(*Channel))

func (*ChannelCollection) Find ¶

func (cc *ChannelCollection) Find(channelId nocan.ChannelId) *Channel

func (*ChannelCollection) Lookup ¶

func (cc *ChannelCollection) Lookup(channelName string) *Channel

func (*ChannelCollection) Register ¶

func (cc *ChannelCollection) Register(channelName string) (*Channel, error)

func (*ChannelCollection) Unregister ¶

func (cc *ChannelCollection) Unregister(channel *Channel) bool

type JsonCacheEntry ¶

type JsonCacheEntry struct {
	Udid   string
	NodeId nocan.NodeId
}

type Node ¶

type Node struct {
	State           NodeState
	Id              nocan.NodeId
	Udid            Udid8
	LastSeen        time.Time
	FirmwareVersion uint8
	Attributes      map[string]string
}

Node

func NewNode ¶

func NewNode(id nocan.NodeId, udid Udid8, fw_version uint8) *Node

func (*Node) ExpandAttributes ¶

func (n *Node) ExpandAttributes(s string) string

func (*Node) GetAttribute ¶

func (n *Node) GetAttribute(attr string) string

func (*Node) SetAttribute ¶

func (n *Node) SetAttribute(attr string, value string)

func (*Node) String ¶

func (n *Node) String() string

func (*Node) Touch ¶

func (n *Node) Touch()

type NodeCollection ¶

type NodeCollection struct {
	Mutex sync.RWMutex
	Nodes [128]*Node
	Udids map[Udid8]*Node
}

NodeCollection

func NewNodeCollection ¶

func NewNodeCollection() *NodeCollection

func (*NodeCollection) Clear ¶

func (nc *NodeCollection) Clear()

func (*NodeCollection) Each ¶

func (nc *NodeCollection) Each(cb func(node *Node))

func (*NodeCollection) Find ¶

func (nc *NodeCollection) Find(id nocan.NodeId) *Node

func (*NodeCollection) Lookup ¶

func (nc *NodeCollection) Lookup(udid Udid8) *Node

func (*NodeCollection) Register ¶

func (nc *NodeCollection) Register(udid Udid8, fw_version uint8) (*Node, error)

func (*NodeCollection) Unregister ¶

func (nc *NodeCollection) Unregister(node *Node) bool

type NodeState ¶

type NodeState uint

NodeState

const (
	NodeStateUnknown NodeState = iota
	NodeStateConnecting
	NodeStateConnected
	NodeStateBootloader
	NodeStateRunning
	NodeStateProgramming
	NodeStateUnresponsive
	NodeStateCount
)

func (NodeState) MarshalJSON ¶

func (ns NodeState) MarshalJSON() ([]byte, error)

func (NodeState) String ¶

func (ns NodeState) String() string

type Udid8 ¶

type Udid8 [8]byte

Udid8

func CreateUdid8 ¶

func CreateUdid8(b []byte) Udid8

func (Udid8) DecodeString ¶

func (id Udid8) DecodeString(s string) error

func (Udid8) MarshalJSON ¶

func (id Udid8) MarshalJSON() ([]byte, error)

func (Udid8) String ¶

func (id Udid8) String() string

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
can
device
helpers
nocan
properties
rpi

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL