package sunbee

import "github.com/muesli/beehive/bees/sunbee"

Package sunbee is a bee that sends sunrise/sunset event based on the selected location.

Index ¶

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

Package Files ¶

sunbee.go sunbeefactory.go

type SunBee ¶ Uses

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

SunBee is a Bee that alerts you when the sun goes up/down.

func (*SunBee) Action ¶ Uses

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

Action triggers the action passed to it.

func (*SunBee) ReloadOptions ¶ Uses

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

ReloadOptions parses the config options and initializes the Bee.

func (*SunBee) Run ¶ Uses

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

Run executes the Bee's event loop.

type SunBeeFactory ¶ Uses

type SunBeeFactory struct {
    bees.BeeFactory
}

SunBeeFactory is a factory for SunBees.

func (*SunBeeFactory) Description ¶ Uses

func (factory *SunBeeFactory) Description() string

Description returns the description of this Bee.

func (*SunBeeFactory) Events ¶ Uses

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

func (*SunBeeFactory) ID ¶ Uses

func (factory *SunBeeFactory) ID() string

ID returns the ID of this Bee.

func (*SunBeeFactory) Image ¶ Uses

func (factory *SunBeeFactory) Image() string

Image returns the filename of an image for this Bee.

func (*SunBeeFactory) Name ¶ Uses

func (factory *SunBeeFactory) Name() string

Name returns the name of this Bee.

func (*SunBeeFactory) New ¶ Uses

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

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

func (*SunBeeFactory) Options ¶ Uses

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

Options returns the options available to configure this Bee.