Mathematica - Ambient Light Bricklet 2.0 – Tinkerforge

- Getting Started
  - Primer
  - Tutorials
  - FAQ
- Hardware
  - Bricks
  - Bricklets
  - Master Extensions
  - Power Supplies
  - Accessories
  - Timeline
- Software
  - Brick Daemon (brickd)
  - Brick Viewer (brickv)
  - API Bindings
  - Firmwares and Plugins
  - Device Identifier
  - Source Code and Bug Tracking
  - Programming Interface
- Starter Kits
  - Weather Station
  - Hardware Hacking
  - Server Room Monitoring
  - Blinkenlights
  - Internet of Things
  - Camera Slider
- Embedded Boards
  - Raspberry Pi
- Specifications
  - Technical Data
  - TCP/IP Protocol
  - Modbus Protocol
  - Wireshark Dissector

# Mathematica - Ambient Light Bricklet 2.0

Note

This Bricklet is currently in the prototype stage and the software/hardware as well as the documentation is in an incomplete state.

This is the description of the Mathematica API bindings for the Ambient Light Bricklet 2.0. General information and technical specifications for the Ambient Light Bricklet 2.0 are summarized in its hardware description.

An installation guide for the Mathematica API bindings is part of their general description.

## Examples

The example code below is Public Domain (CC0 1.0).

### Simple

Download (ExampleSimple.nb)

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19

    Needs["NETLink`"]
    LoadNETAssembly["Tinkerforge",NotebookDirectory[]<>"../../.."]

    host="localhost"
    port=4223
    uid="amb"(* Change to your UID *)

    (* Create IPConnection and device object *)
    ipcon=NETNew["Tinkerforge.IPConnection"]
    al=NETNew["Tinkerforge.BrickletAmbientLightV2",uid,ipcon]
    ipcon@Connect[host,port]

    (* Get current illuminance (unit is Lux/100) *)
    Print["Illuminance: "<>ToString[N[Quantity[al@GetIlluminance[],"Lux/100"]]]]

    (* Clean up *)
    ipcon@Disconnect[]
    ReleaseNETObject[al]
    ReleaseNETObject[ipcon]

### Callback

Download (ExampleCallback.nb)

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28

    Needs["NETLink`"]
    LoadNETAssembly["Tinkerforge",NotebookDirectory[]<>"../../.."]

    host="localhost"
    port=4223
    uid="amb"(* Change to your UID *)

    (* Create IPConnection and device object *)
    ipcon=NETNew["Tinkerforge.IPConnection"]
    al=NETNew["Tinkerforge.BrickletAmbientLightV2",uid,ipcon]
    ipcon@Connect[host,port]

    (* Set Period for illuminance callback to 1s (1000ms) *)
    (* Note: The illuminance callback is only called every second if the *)
    (*       illuminance has changed since the last call! *)
    al@SetIlluminanceCallbackPeriod[1000]

    (* Callback function for illuminance callback (parameter has unit Lux/100) *)
    IlluminanceCB[sender_,illuminance_]:=
     Print["Illuminance: "<>ToString[N[Quantity[illuminance,"Lux/100"]]]]
    AddEventHandler[al@Illuminance,IlluminanceCB]

    Input["Click OK to exit"]

    (* Clean up *)
    ipcon@Disconnect[]
    ReleaseNETObject[al]
    ReleaseNETObject[ipcon]

### Threshold

Download (ExampleThreshold.nb)

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34

    Needs["NETLink`"]
    LoadNETAssembly["Tinkerforge",NotebookDirectory[]<>"../../.."]

    host="localhost"
    port=4223
    uid="amb"(* Change to your UID *)

    (* Create IPConnection and device object *)
    ipcon=NETNew["Tinkerforge.IPConnection"]
    al=NETNew["Tinkerforge.BrickletAmbientLightV2",uid,ipcon]
    ipcon@Connect[host,port]

    (* Get threshold callbacks with a debounce time of 10 seconds (10000ms) *)
    al@SetDebouncePeriod[10000]

    (* Callback for illuminance greater than 200 Lux *)
    IlluminanceReachedCB[sender_,illuminance_]:=
     Module[{},
      Print["We have "<>ToString[N[Quantity[illuminance,"Lux/100"]]]<>"."];
      Print["Too bright, close the curtains!"]
     ]

    AddEventHandler[al@IlluminanceReached,IlluminanceReachedCB]

    (* Configure threshold for "greater than 200 Lux" (unit is Lux/100) *)
    option=Tinkerforge`BrickletAmbientLightV2`THRESHOLDUOPTIONUGREATER
    al@SetIlluminanceCallbackThreshold[option,200*100,0]

    Input["Click OK to exit"]

    (* Clean up *)
    ipcon@Disconnect[]
    ReleaseNETObject[al]
    ReleaseNETObject[ipcon]

## API

Generally, every method of the Mathematica bindings that returns a value can throw a `Tinkerforge.TimeoutException`. This exception gets thrown if the device did not respond. If a cable based connection is used, it is unlikely that this exception gets thrown (assuming nobody plugs the device out). However, if a wireless connection is used, timeouts will occur if the distance to the device gets too big.

Since .NET/Link does not support multiple return values directly, we use the `out` keyword to return multiple values from a method. For further information about the `out` keyword in .NET/Link see the corresponding Mathematica .NET/Link documentation.

The namespace for all Brick/Bricklet bindings and the IPConnection is `Tinkerforge.*`.

### Basic Functions

`BrickletAmbientLightV2`[uid, ipcon] → ambientLightV2

  Parameters:

  - uid -- String
  - ipcon -- NETObject[IPConnection]

  Returns:

  - ambientLightV2 -- NETObject[BrickletAmbientLightV2]

  Creates an object with the unique device ID `uid`:

      ambientLightV2=NETNew["Tinkerforge.BrickletAmbientLightV2","YOUR_DEVICE_UID",ipcon]

  This object can then be used after the IP Connection is connected (see examples above).

  The .NET runtime has built-in garbage collection that frees objects that are no longer in use by a program. But because Mathematica can not automatically tell when a Mathematica "program" doesn't use a .NET object anymore, this has to be done by the program. For this the ReleaseNETObject[] function is used in the examples.

  For further information about object management in .NET/Link see the corresponding Mathematica .NET/Link documentation.

`BrickletAmbientLightV2``@``GetIlluminance`[] → illuminance

  Returns:

  - illuminance -- Integer

  Returns the illuminance of the ambient light sensor. The value has a range of 0 to 6400000 and is given in 1/100 Lux, i.e. a value of 45000 means that an illuminance of 450 Lux is measured.

  If you want to get the illuminance periodically, it is recommended to use the callback `Illuminance` and set the period with `SetIlluminanceCallbackPeriod[]`.

### Advanced Functions

`BrickletAmbientLightV2``@``SetConfiguration`[illuminanceRange, integrationTime] → Null

  Parameters:

  - illuminanceRange -- Integer
  - integrationTime -- Integer

  Sets the configuration. It is possible to configure an illuminance range between 0-600lux and 0-64000lux and an integration time between 50ms and 400ms.

  A smaller illuminance range increases the resolution of the data. An increase in integration time will result in less noise on the data.

  The default values are 0-8000lux illuminance range and 200ms integration time.

  The following constants are available for this function:

  - BrickletAmbientLightV2`ILLUMINANCEURANGEU64000LUX = 0
  - BrickletAmbientLightV2`ILLUMINANCEURANGEU32000LUX = 1
  - BrickletAmbientLightV2`ILLUMINANCEURANGEU16000LUX = 2
  - BrickletAmbientLightV2`ILLUMINANCEURANGEU8000LUX = 3
  - BrickletAmbientLightV2`ILLUMINANCEURANGEU1300LUX = 4
  - BrickletAmbientLightV2`ILLUMINANCEURANGEU600LUX = 5
  - BrickletAmbientLightV2`INTEGRATIONUTIMEU50MS = 0
  - BrickletAmbientLightV2`INTEGRATIONUTIMEU100MS = 1
  - BrickletAmbientLightV2`INTEGRATIONUTIMEU150MS = 2
  - BrickletAmbientLightV2`INTEGRATIONUTIMEU200MS = 3
  - BrickletAmbientLightV2`INTEGRATIONUTIMEU250MS = 4
  - BrickletAmbientLightV2`INTEGRATIONUTIMEU300MS = 5
  - BrickletAmbientLightV2`INTEGRATIONUTIMEU350MS = 6
  - BrickletAmbientLightV2`INTEGRATIONUTIMEU400MS = 7

`BrickletAmbientLightV2``@``GetConfiguration`[out illuminanceRange, out integrationTime] → Null

  Parameters:

  - illuminanceRange -- Integer
  - integrationTime -- Integer

  Returns the configuration as set by `SetConfiguration[]`.

  The following constants are available for this function:

  - BrickletAmbientLightV2`ILLUMINANCEURANGEU64000LUX = 0
  - BrickletAmbientLightV2`ILLUMINANCEURANGEU32000LUX = 1
  - BrickletAmbientLightV2`ILLUMINANCEURANGEU16000LUX = 2
  - BrickletAmbientLightV2`ILLUMINANCEURANGEU8000LUX = 3
  - BrickletAmbientLightV2`ILLUMINANCEURANGEU1300LUX = 4
  - BrickletAmbientLightV2`ILLUMINANCEURANGEU600LUX = 5
  - BrickletAmbientLightV2`INTEGRATIONUTIMEU50MS = 0
  - BrickletAmbientLightV2`INTEGRATIONUTIMEU100MS = 1
  - BrickletAmbientLightV2`INTEGRATIONUTIMEU150MS = 2
  - BrickletAmbientLightV2`INTEGRATIONUTIMEU200MS = 3
  - BrickletAmbientLightV2`INTEGRATIONUTIMEU250MS = 4
  - BrickletAmbientLightV2`INTEGRATIONUTIMEU300MS = 5
  - BrickletAmbientLightV2`INTEGRATIONUTIMEU350MS = 6
  - BrickletAmbientLightV2`INTEGRATIONUTIMEU400MS = 7

`BrickletAmbientLightV2``@``GetAPIVersion`[] → {apiVersion1, apiVersion2, apiVersion3}

  Returns:

  - apiVersioni -- Integer

  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.

`BrickletAmbientLightV2``@``GetResponseExpected`[functionId] → responseExpected

  Parameters:

  - functionId -- Integer

  Returns:

  - responseExpected -- True/False

  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.

`BrickletAmbientLightV2``@``SetResponseExpected`[functionId, responseExpected] → Null

  Parameters:

  - functionId -- Integer
  - responseExpected -- True/False

  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 and callbacks it is always disabled.

  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.

  The following function ID constants are available for this function:

  - BrickletAmbientLightV2`FUNCTIONUSETUILLUMINANCEUCALLBACKUPERIOD = 2
  - BrickletAmbientLightV2`FUNCTIONUSETUILLUMINANCEUCALLBACKUTHRESHOLD = 4
  - BrickletAmbientLightV2`FUNCTIONUSETUDEBOUNCEUPERIOD = 6
  - BrickletAmbientLightV2`FUNCTIONUSETUCONFIGURATION = 8

`BrickletAmbientLightV2``@``SetResponseExpectedAll`[responseExpected] → Null

  Parameters:

  - responseExpected -- True/False

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

`BrickletAmbientLightV2``@``GetIdentity`[out uid, out connectedUid, out position, out {hardwareVersion1, hardwareVersion2, hardwareVersion3}, out {firmwareVersion1, firmwareVersion2, firmwareVersion3}, out deviceIdentifier] → Null

  Parameters:

  - uid -- String
  - connectedUid -- String
  - position -- Integer
  - hardwareVersioni -- Integer
  - firmwareVersioni -- Integer
  - deviceIdentifier -- Integer

  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. There is also a constant for the device identifier of this Bricklet.

### Callback Configuration Functions

`BrickletAmbientLightV2``@``SetIlluminanceCallbackPeriod`[period] → Null

  Parameters:

  - period -- Integer

  Sets the period in ms with which the `Illuminance` callback is triggered periodically. A value of 0 turns the callback off.

  `Illuminance` is only triggered if the illuminance has changed since the last triggering.

  The default value is 0.

`BrickletAmbientLightV2``@``GetIlluminanceCallbackPeriod`[] → period

  Returns:

  - period -- Integer

  Returns the period as set by `SetIlluminanceCallbackPeriod[]`.

`BrickletAmbientLightV2``@``SetIlluminanceCallbackThreshold`[option, min, max] → Null

  Parameters:

  - option -- Integer
  - min -- Integer
  - max -- Integer

  Sets the thresholds for the `IlluminanceReached` callback.

  The following options are possible:

  Option | Description
  --- | ---
  'x' | Callback is turned off
  'o' | Callback is triggered when the illuminance is outside the min and max values
  'i' | Callback is triggered when the illuminance is inside the min and max values
  '<' | Callback is triggered when the illuminance is smaller than the min value (max is ignored)
  '>' | Callback is triggered when the illuminance is greater than the min value (max is ignored)

  The default value is ('x', 0, 0).

  The following constants are available for this function:

  - BrickletAmbientLightV2`THRESHOLDUOPTIONUOFF = `ToCharacterCode["x"][[0]]`
  - BrickletAmbientLightV2`THRESHOLDUOPTIONUOUTSIDE = `ToCharacterCode["o"][[0]]`
  - BrickletAmbientLightV2`THRESHOLDUOPTIONUINSIDE = `ToCharacterCode["i"][[0]]`
  - BrickletAmbientLightV2`THRESHOLDUOPTIONUSMALLER = `ToCharacterCode["<"][[0]]`
  - BrickletAmbientLightV2`THRESHOLDUOPTIONUGREATER = `ToCharacterCode[">"][[0]]`

`BrickletAmbientLightV2``@``GetIlluminanceCallbackThreshold`[out option, out min, out max] → Null

  Parameters:

  - option -- Integer
  - min -- Integer
  - max -- Integer

  Returns the threshold as set by `SetIlluminanceCallbackThreshold[]`.

  The following constants are available for this function:

  - BrickletAmbientLightV2`THRESHOLDUOPTIONUOFF = `ToCharacterCode["x"][[0]]`
  - BrickletAmbientLightV2`THRESHOLDUOPTIONUOUTSIDE = `ToCharacterCode["o"][[0]]`
  - BrickletAmbientLightV2`THRESHOLDUOPTIONUINSIDE = `ToCharacterCode["i"][[0]]`
  - BrickletAmbientLightV2`THRESHOLDUOPTIONUSMALLER = `ToCharacterCode["<"][[0]]`
  - BrickletAmbientLightV2`THRESHOLDUOPTIONUGREATER = `ToCharacterCode[">"][[0]]`

`BrickletAmbientLightV2``@``SetDebouncePeriod`[debounce] → Null

  Parameters:

  - debounce -- Integer

  Sets the period in ms with which the threshold callbacks

  - `IlluminanceReached`,

  are triggered, if the thresholds

  - `SetIlluminanceCallbackThreshold[]`,

  keep being reached.

  The default value is 100.

`BrickletAmbientLightV2``@``GetDebouncePeriod`[] → debounce

  Returns:

  - debounce -- Integer

  Returns the debounce period as set by `SetDebouncePeriod[]`.

### Callbacks

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done by assigning a function to a callback property of the device object:

>     Callback[sender_,value_]:=Print["Value: "<>ToString[value]]

>     AddEventHandler[ambientLightV2@Example,Callback]

For further information about event handling using .NET/Link see the corresponding Mathematica .NET/Link documentation.

The available callback property and their type of parameters are described below.

Note

Using callbacks for recurring events is always preferred compared to using getters. It will use less USB bandwidth and the latency will be a lot better, since there is no round trip time.

event `BrickletAmbientLightV2``@``Illuminance`[sender, illuminance]

  Parameters:

  - sender -- NETObject[BrickletAmbientLightV2]
  - illuminance -- Integer

  This callback is triggered periodically with the period that is set by `SetIlluminanceCallbackPeriod[]`. The parameter is the illuminance of the ambient light sensor.

  `Illuminance` is only triggered if the illuminance has changed since the last triggering.

event `BrickletAmbientLightV2``@``IlluminanceReached`[sender, illuminance]

  Parameters:

  - sender -- NETObject[BrickletAmbientLightV2]
  - illuminance -- Integer

  This callback is triggered when the threshold as set by `SetIlluminanceCallbackThreshold[]` is reached. The parameter is the illuminance of the ambient light sensor.

  If the threshold keeps being reached, the callback is triggered periodically with the period as set by `SetDebouncePeriod[]`.

### Constants

`BrickletAmbientLightV2`````DEVICEUIDENTIFIER`

  This constant is used to identify a Ambient Light Bricklet 2.0.

  The `GetIdentity[]` function and the `EnumerateCallback` callback of the IP Connection have a `deviceIdentifier` parameter to specify the Brick's or Bricklet's type.

The content of this page is licensed under Creative Commons Attribution 3.0 Unported License.