serialbee

Documentation

Overview

Package serialbee is a Bee that can send & receive data on a serial port.

Index

• type SerialBee
  • func (mod *SerialBee) Action(action bees.Action) []bees.Placeholder
  • func (mod *SerialBee) ReloadOptions(options bees.BeeOptions)
  • func (mod *SerialBee) Run(eventChan chan bees.Event)
• type SerialBeeFactory
  • func (factory *SerialBeeFactory) Actions() []bees.ActionDescriptor
  • func (factory *SerialBeeFactory) Description() string
  • func (factory *SerialBeeFactory) Events() []bees.EventDescriptor
  • func (factory *SerialBeeFactory) ID() string
  • func (factory *SerialBeeFactory) Image() string
  • func (factory *SerialBeeFactory) LogoColor() string
  • func (factory *SerialBeeFactory) Name() string
  • func (factory *SerialBeeFactory) New(name, description string, options bees.BeeOptions) bees.BeeInterface
  • func (factory *SerialBeeFactory) Options() []bees.BeeOptionDescriptor

Types

type SerialBee

type SerialBee struct {
	bees.Bee
	// contains filtered or unexported fields
}

SerialBee is a Bee that can send & receive data on a serial port.

func (*SerialBee) Action

func (mod *SerialBee) Action(action bees.Action) []bees.Placeholder

Action triggers the action passed to it.

func (*SerialBee) ReloadOptions

func (mod *SerialBee) ReloadOptions(options bees.BeeOptions)

ReloadOptions parses the config options and initializes the Bee.

func (*SerialBee) Run

func (mod *SerialBee) Run(eventChan chan bees.Event)

Run executes the Bee's event loop.

type SerialBeeFactory

type SerialBeeFactory struct {
	bees.BeeFactory
}

SerialBeeFactory is a factory for SerialBees.

func (*SerialBeeFactory) Actions

func (factory *SerialBeeFactory) Actions() []bees.ActionDescriptor

Actions describes the available actions provided by this Bee.

func (*SerialBeeFactory) Description

func (factory *SerialBeeFactory) Description() string

Description returns the description of this Bee.

func (*SerialBeeFactory) Events

func (factory *SerialBeeFactory) Events() []bees.EventDescriptor

Events describes the available events provided by this Bee.

func (*SerialBeeFactory) ID

func (factory *SerialBeeFactory) ID() string

ID returns the ID of this Bee.

func (*SerialBeeFactory) Image

func (factory *SerialBeeFactory) Image() string

Image returns the filename of an image for this Bee.

func (*SerialBeeFactory) LogoColor

func (factory *SerialBeeFactory) LogoColor() string

LogoColor returns the preferred logo background color (used by the admin interface).

func (*SerialBeeFactory) Name

func (factory *SerialBeeFactory) Name() string

Name returns the name of this Bee.

func (*SerialBeeFactory) New

func (factory *SerialBeeFactory) New(name, description string, options bees.BeeOptions) bees.BeeInterface

New returns a new Bee instance configured with the supplied options.

func (*SerialBeeFactory) Options

func (factory *SerialBeeFactory) Options() []bees.BeeOptionDescriptor

Options returns the options available to configure this Bee.