go-api-bindings: github.com/Tinkerforge/go-api-bindings/motion_detector_bricklet Index | Files

package motion_detector_bricklet

import "github.com/Tinkerforge/go-api-bindings/motion_detector_bricklet"

Passive infrared (PIR) motion sensor with 7m range.

See also the documentation here: https://www.tinkerforge.com/en/doc/Software/Bricklets/MotionDetector_Bricklet_Go.html.

Index

Package Files

motion_detector_bricklet.go

Constants

const DeviceDisplayName = "Motion Detector Bricklet"
const DeviceIdentifier = 233

type Function Uses

type Function = uint8
const (
    FunctionGetMotionDetected           Function = 1
    FunctionSetStatusLEDConfig          Function = 4
    FunctionGetStatusLEDConfig          Function = 5
    FunctionGetIdentity                 Function = 255
    FunctionCallbackMotionDetected      Function = 2
    FunctionCallbackDetectionCycleEnded Function = 3
)

type Motion Uses

type Motion = uint8
const (
    MotionNotDetected Motion = 0
    MotionDetected    Motion = 1
)

type MotionDetectorBricklet Uses

type MotionDetectorBricklet struct {
    // contains filtered or unexported fields
}

func New Uses

func New(uid string, ipcon *ipconnection.IPConnection) (MotionDetectorBricklet, error)

Creates an object with the unique device ID `uid`. This object can then be used after the IP Connection `ipcon` is connected.

func (*MotionDetectorBricklet) DeregisterDetectionCycleEndedCallback Uses

func (device *MotionDetectorBricklet) DeregisterDetectionCycleEndedCallback(registrationId uint64)

Remove a registered Detection Cycle Ended callback.

func (*MotionDetectorBricklet) DeregisterMotionDetectedCallback Uses

func (device *MotionDetectorBricklet) DeregisterMotionDetectedCallback(registrationId uint64)

Remove a registered Motion Detected callback.

func (*MotionDetectorBricklet) GetAPIVersion Uses

func (device *MotionDetectorBricklet) GetAPIVersion() [3]uint8

Returns the version of the API definition (major, minor, revision) implemented by this API bindings. This is neither the release version of this API bindings nor does it tell you anything about the represented Brick or Bricklet.

func (*MotionDetectorBricklet) GetIdentity Uses

func (device *MotionDetectorBricklet) GetIdentity() (uid string, connectedUid string, position rune, hardwareVersion [3]uint8, firmwareVersion [3]uint8, deviceIdentifier uint16, err error)

Returns the UID, the UID where the Bricklet is connected to, the position, the hardware and firmware version as well as the device identifier.

The position can be 'a', 'b', 'c' or 'd'.

The device identifier numbers can be found `here <device_identifier>`. |device_identifier_constant|

func (*MotionDetectorBricklet) GetMotionDetected Uses

func (device *MotionDetectorBricklet) GetMotionDetected() (motion Motion, err error)

Returns 1 if a motion was detected. How long this returns 1 after a motion was detected can be adjusted with one of the small potentiometers on the Motion Detector Bricklet, see `here <motion_detector_bricklet_sensitivity_delay_block_time>`.

There is also a blue LED on the Bricklet that is on as long as the Bricklet is in the motion detected state.

Associated constants:

* MotionNotDetected
* MotionDetected

func (*MotionDetectorBricklet) GetResponseExpected Uses

func (device *MotionDetectorBricklet) GetResponseExpected(functionID Function) (bool, error)

Returns the response expected flag for the function specified by the function ID parameter. It is true if the function is expected to send a response, false otherwise.

For getter functions this is enabled by default and cannot be disabled, because those functions will always send a response. For callback configuration functions it is enabled by default too, but can be disabled by SetResponseExpected. For setter functions it is disabled by default and can be enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is send and errors are silently ignored, because they cannot be detected.

See SetResponseExpected for the list of function ID constants available for this function.

func (*MotionDetectorBricklet) GetStatusLEDConfig Uses

func (device *MotionDetectorBricklet) GetStatusLEDConfig() (config StatusLEDConfig, err error)

Returns the configuration as set by SetStatusLEDConfig.

.. versionadded:: 2.0.1$nbsp;(Plugin)

Associated constants:

* StatusLEDConfigOff
* StatusLEDConfigOn
* StatusLEDConfigShowStatus

func (*MotionDetectorBricklet) RegisterDetectionCycleEndedCallback Uses

func (device *MotionDetectorBricklet) RegisterDetectionCycleEndedCallback(fn func()) uint64

This callback is called when the detection cycle ended. When this callback is called, a new motion can be detected again after approximately 2 seconds.

func (*MotionDetectorBricklet) RegisterMotionDetectedCallback Uses

func (device *MotionDetectorBricklet) RegisterMotionDetectedCallback(fn func()) uint64

This callback is called after a motion was detected.

func (*MotionDetectorBricklet) SetResponseExpected Uses

func (device *MotionDetectorBricklet) SetResponseExpected(functionID Function, responseExpected bool) error

Changes the response expected flag of the function specified by the function ID parameter. This flag can only be changed for setter (default value: false) and callback configuration functions (default value: true). For getter functions it is always enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is send and errors are silently ignored, because they cannot be detected.

func (*MotionDetectorBricklet) SetResponseExpectedAll Uses

func (device *MotionDetectorBricklet) SetResponseExpectedAll(responseExpected bool)

Changes the response expected flag for all setter and callback configuration functions of this device at once.

func (*MotionDetectorBricklet) SetStatusLEDConfig Uses

func (device *MotionDetectorBricklet) SetStatusLEDConfig(config StatusLEDConfig) (err error)

Sets the status led configuration.

By default the status LED turns on if a motion is detected and off is no motion is detected.

You can also turn the LED permanently on/off.

.. versionadded:: 2.0.1$nbsp;(Plugin)

Associated constants:

* StatusLEDConfigOff
* StatusLEDConfigOn
* StatusLEDConfigShowStatus

type StatusLEDConfig Uses

type StatusLEDConfig = uint8
const (
    StatusLEDConfigOff        StatusLEDConfig = 0
    StatusLEDConfigOn         StatusLEDConfig = 1
    StatusLEDConfigShowStatus StatusLEDConfig = 2
)

Package motion_detector_bricklet imports 4 packages (graph). Updated 2019-09-16. Refresh now. Tools for package owners.