motion_detector_v2_bricklet

package
Version: v0.0.0-...-8a98e63 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 11, 2022 License: CC0-1.0 Imports: 5 Imported by: 0

Documentation

Overview

Passive infrared (PIR) motion sensor with 12m range and dimmable backlight.

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

Index

Constants

View Source
const DeviceDisplayName = "Motion Detector Bricklet 2.0"
View Source
const DeviceIdentifier = 292

Variables

This section is empty.

Functions

This section is empty.

Types

type BootloaderMode

type BootloaderMode = uint8
const (
	BootloaderModeBootloader                    BootloaderMode = 0
	BootloaderModeFirmware                      BootloaderMode = 1
	BootloaderModeBootloaderWaitForReboot       BootloaderMode = 2
	BootloaderModeFirmwareWaitForReboot         BootloaderMode = 3
	BootloaderModeFirmwareWaitForEraseAndReboot BootloaderMode = 4
)

type BootloaderStatus

type BootloaderStatus = uint8
const (
	BootloaderStatusOK                        BootloaderStatus = 0
	BootloaderStatusInvalidMode               BootloaderStatus = 1
	BootloaderStatusNoChange                  BootloaderStatus = 2
	BootloaderStatusEntryFunctionNotPresent   BootloaderStatus = 3
	BootloaderStatusDeviceIdentifierIncorrect BootloaderStatus = 4
	BootloaderStatusCRCMismatch               BootloaderStatus = 5
)

type Function

type Function = uint8
const (
	FunctionGetMotionDetected           Function = 1
	FunctionSetSensitivity              Function = 2
	FunctionGetSensitivity              Function = 3
	FunctionSetIndicator                Function = 4
	FunctionGetIndicator                Function = 5
	FunctionGetSPITFPErrorCount         Function = 234
	FunctionSetBootloaderMode           Function = 235
	FunctionGetBootloaderMode           Function = 236
	FunctionSetWriteFirmwarePointer     Function = 237
	FunctionWriteFirmware               Function = 238
	FunctionSetStatusLEDConfig          Function = 239
	FunctionGetStatusLEDConfig          Function = 240
	FunctionGetChipTemperature          Function = 242
	FunctionReset                       Function = 243
	FunctionWriteUID                    Function = 248
	FunctionReadUID                     Function = 249
	FunctionGetIdentity                 Function = 255
	FunctionCallbackMotionDetected      Function = 6
	FunctionCallbackDetectionCycleEnded Function = 7
)

type Motion

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

type MotionDetectorV2Bricklet

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

func New

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

func (*MotionDetectorV2Bricklet) DeregisterDetectionCycleEndedCallback

func (device *MotionDetectorV2Bricklet) DeregisterDetectionCycleEndedCallback(registrationId uint64)

Remove a registered Detection Cycle Ended callback.

func (*MotionDetectorV2Bricklet) DeregisterMotionDetectedCallback

func (device *MotionDetectorV2Bricklet) DeregisterMotionDetectedCallback(registrationId uint64)

Remove a registered Motion Detected callback.

func (*MotionDetectorV2Bricklet) GetAPIVersion

func (device *MotionDetectorV2Bricklet) 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 (*MotionDetectorV2Bricklet) GetBootloaderMode

func (device *MotionDetectorV2Bricklet) GetBootloaderMode() (mode BootloaderMode, err error)

Returns the current bootloader mode, see SetBootloaderMode.

Associated constants:

* BootloaderModeBootloader
* BootloaderModeFirmware
* BootloaderModeBootloaderWaitForReboot
* BootloaderModeFirmwareWaitForReboot
* BootloaderModeFirmwareWaitForEraseAndReboot

func (*MotionDetectorV2Bricklet) GetChipTemperature

func (device *MotionDetectorV2Bricklet) GetChipTemperature() (temperature int16, err error)

Returns the temperature as measured inside the microcontroller. The value returned is not the ambient temperature!

The temperature is only proportional to the real temperature and it has bad accuracy. Practically it is only useful as an indicator for temperature changes.

func (*MotionDetectorV2Bricklet) GetIdentity

func (device *MotionDetectorV2Bricklet) 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', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port). A Bricklet connected to an `Isolator Bricklet <isolator_bricklet>` is always at position 'z'.

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

func (*MotionDetectorV2Bricklet) GetIndicator

func (device *MotionDetectorV2Bricklet) GetIndicator() (topLeft uint8, topRight uint8, bottom uint8, err error)

Returns the indicator configuration as set by SetIndicator.

func (*MotionDetectorV2Bricklet) GetMotionDetected

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

Returns 1 if a motion was detected. It returns 1 approx. for 1.8 seconds until the sensor checks for a new movement.

Associated constants:

* MotionNotDetected
* MotionDetected

func (*MotionDetectorV2Bricklet) GetResponseExpected

func (device *MotionDetectorV2Bricklet) 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 sent and errors are silently ignored, because they cannot be detected.

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

func (*MotionDetectorV2Bricklet) GetSPITFPErrorCount

func (device *MotionDetectorV2Bricklet) GetSPITFPErrorCount() (errorCountAckChecksum uint32, errorCountMessageChecksum uint32, errorCountFrame uint32, errorCountOverflow uint32, err error)

Returns the error count for the communication between Brick and Bricklet.

The errors are divided into

* ACK checksum errors, * message checksum errors, * framing errors and * overflow errors.

The errors counts are for errors that occur on the Bricklet side. All Bricks have a similar function that returns the errors on the Brick side.

func (*MotionDetectorV2Bricklet) GetSensitivity

func (device *MotionDetectorV2Bricklet) GetSensitivity() (sensitivity uint8, err error)

Returns the sensitivity as set by SetSensitivity.

func (*MotionDetectorV2Bricklet) GetStatusLEDConfig

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

Returns the configuration as set by SetStatusLEDConfig

Associated constants:

* StatusLEDConfigOff
* StatusLEDConfigOn
* StatusLEDConfigShowHeartbeat
* StatusLEDConfigShowStatus

func (*MotionDetectorV2Bricklet) ReadUID

func (device *MotionDetectorV2Bricklet) ReadUID() (uid uint32, err error)

Returns the current UID as an integer. Encode as Base58 to get the usual string version.

func (*MotionDetectorV2Bricklet) RegisterDetectionCycleEndedCallback

func (device *MotionDetectorV2Bricklet) 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 (*MotionDetectorV2Bricklet) RegisterMotionDetectedCallback

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

This callback is called after a motion was detected.

func (*MotionDetectorV2Bricklet) Reset

func (device *MotionDetectorV2Bricklet) Reset() (err error)

Calling this function will reset the Bricklet. All configurations will be lost.

After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!

func (*MotionDetectorV2Bricklet) SetBootloaderMode

func (device *MotionDetectorV2Bricklet) SetBootloaderMode(mode BootloaderMode) (status BootloaderStatus, err error)

Sets the bootloader mode and returns the status after the requested mode change was instigated.

You can change from bootloader mode to firmware mode and vice versa. A change from bootloader mode to firmware mode will only take place if the entry function, device identifier and CRC are present and correct.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

Associated constants:

* BootloaderModeBootloader
* BootloaderModeFirmware
* BootloaderModeBootloaderWaitForReboot
* BootloaderModeFirmwareWaitForReboot
* BootloaderModeFirmwareWaitForEraseAndReboot
* BootloaderStatusOK
* BootloaderStatusInvalidMode
* BootloaderStatusNoChange
* BootloaderStatusEntryFunctionNotPresent
* BootloaderStatusDeviceIdentifierIncorrect
* BootloaderStatusCRCMismatch

func (*MotionDetectorV2Bricklet) SetIndicator

func (device *MotionDetectorV2Bricklet) SetIndicator(topLeft uint8, topRight uint8, bottom uint8) (err error)

Sets the blue backlight of the fresnel lens. The backlight consists of three LEDs. The brightness of each LED can be controlled with a 8-bit value (0-255). A value of 0 turns the LED off and a value of 255 turns the LED to full brightness.

func (*MotionDetectorV2Bricklet) SetResponseExpected

func (device *MotionDetectorV2Bricklet) 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 sent and errors are silently ignored, because they cannot be detected.

func (*MotionDetectorV2Bricklet) SetResponseExpectedAll

func (device *MotionDetectorV2Bricklet) SetResponseExpectedAll(responseExpected bool)

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

func (*MotionDetectorV2Bricklet) SetSensitivity

func (device *MotionDetectorV2Bricklet) SetSensitivity(sensitivity uint8) (err error)

Sets the sensitivity of the PIR sensor. At full sensitivity (100), the Bricklet can detect motion in a range of approximately 12m.

The actual range depends on many things in the environment (e.g. reflections) and the size of the object to be detected. While a big person might be detected in a range of 10m a cat may only be detected at 2m distance with the same setting.

So you will have to find a good sensitivity for your application by trial and error.

func (*MotionDetectorV2Bricklet) SetStatusLEDConfig

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

Sets the status LED configuration. By default the LED shows communication traffic between Brick and Bricklet, it flickers once for every 10 received data packets.

You can also turn the LED permanently on/off or show a heartbeat.

If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.

Associated constants:

* StatusLEDConfigOff
* StatusLEDConfigOn
* StatusLEDConfigShowHeartbeat
* StatusLEDConfigShowStatus

func (*MotionDetectorV2Bricklet) SetWriteFirmwarePointer

func (device *MotionDetectorV2Bricklet) SetWriteFirmwarePointer(pointer uint32) (err error)

Sets the firmware pointer for WriteFirmware. The pointer has to be increased by chunks of size 64. The data is written to flash every 4 chunks (which equals to one page of size 256).

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

func (*MotionDetectorV2Bricklet) WriteFirmware

func (device *MotionDetectorV2Bricklet) WriteFirmware(data [64]uint8) (status uint8, err error)

Writes 64 Bytes of firmware at the position as written by SetWriteFirmwarePointer before. The firmware is written to flash every 4 chunks.

You can only write firmware in bootloader mode.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

func (*MotionDetectorV2Bricklet) WriteUID

func (device *MotionDetectorV2Bricklet) WriteUID(uid uint32) (err error)

Writes a new UID into flash. If you want to set a new UID you have to decode the Base58 encoded UID string into an integer first.

We recommend that you use Brick Viewer to change the UID.

type StatusLEDConfig

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

Jump to

Keyboard shortcuts

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