ncs

package module

v0.2.0 Latest Latest Go to latest Published: Mar 7, 2019 License: BSD-3-Clause Imports: 12 Imported by: 1

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/go-lsst/ncs

Links

Open Source Insights

README ¶

ncs

ncs is the Nimble Control System.

Installation

sh> go get github.com/go-lsst/ncs

Documentation

Documentation is available at godoc.

Documentation ¶

Index ¶

Constants
Variables
type App
- func New(name string, modules ...Module) (*App, error)
- func (app *App) AddModule(m Module)
- func (app *App) Run() error
type Base
- func NewBase(name string) *Base
type Component
type Device
type Driver
type Module
type Node
type Ticker

Constants ¶

View Source

const (
	// BusAddr is the default rendez-vous point for the system bus
	BusAddr = "tcp://127.0.0.1:40000"
)

Variables ¶

View Source

var System = systemType{
	// contains filtered or unexported fields
}

Functions ¶

This section is empty.

Types ¶

type App ¶

type App struct {
	*Base
	// contains filtered or unexported fields
}

func New ¶

func New(name string, modules ...Module) (*App, error)

func (*App) AddModule ¶

func (app *App) AddModule(m Module)

func (*App) Run ¶

func (app *App) Run() error

type Base ¶

type Base struct {
	*logger.Logger
	// contains filtered or unexported fields
}

func NewBase ¶

func NewBase(name string) *Base

func (*Base) Boot ¶

func (b *Base) Boot(ctx context.Context) error

func (*Base) Send ¶

func (b *Base) Send(data []byte) error

Send sends data on the system bus

func (*Base) Shutdown ¶

func (b *Base) Shutdown(ctx context.Context) error

func (*Base) Tick ¶

func (b *Base) Tick() <-chan time.Time

type Component ¶

type Component interface {
	Name() string
}

type Device ¶

type Device interface {
	Component
}

Device represents a physical device mounted onto some hardware.

type Driver ¶

type Driver interface {
	Component
	Devices() []Device
}

Driver is responsible for initializing devices.

type Module ¶

type Module interface {
	Component
	Boot(ctx context.Context) error
	Start(ctx context.Context) error
	Stop(ctx context.Context) error
	Shutdown(ctx context.Context) error
}

type Node ¶

type Node struct {
	Name  string
	Nodes []Node
}

type Ticker ¶

type Ticker interface {
	Component
	Tick(ctx context.Context) error
}

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
bus
drivers
canbus
hd2001
m702 Package m702 provides r/w access to registers of M702 unidrive motors.	Package m702 provides r/w access to registers of M702 unidrive motors.

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