C# - Ambient Light Bricklet – Tinkerforge

- Getting Started
  - Primer
  - Tutorials
  - FAQ
- Hardware
  - Bricks
  - Bricklets
  - Master Extensions
  - Power Supplies
  - Accessories
  - Timeline
- Software
  - Brick Daemon (brickd)
  - Brick Viewer (brickv)
  - API Bindings
    - C/C++
    - C/C++ (iOS)
    - C#
      - Requirements
      - Installation
      - Testing an Example
      - CLS Compliance
      - API Reference and Examples
        - IP Connection
        - Bricks
        - Bricklets
          - Ambient Light Bricklet
            - Examples
              - Simple
              - Callback
              - Threshold
            - API
              - Basic Functions
              - Advanced Functions
              - Callback Configuration Functions
              - Callbacks
              - Constants
          - Analog In Bricklet
          - Analog Out Bricklet
          - Barometer Bricklet
          - Color Bricklet
          - Current12 Bricklet
          - Current25 Bricklet
          - Distance IR Bricklet
          - Distance US Bricklet
          - Dual Button Bricklet
          - Dual Relay Bricklet
          - GPS Bricklet
          - Hall Effect Bricklet
          - Humidity Bricklet
          - Industrial Digital In 4 Bricklet
          - Industrial Digital Out 4 Bricklet
          - Industrial Dual 0-20mA Bricklet
          - Industrial Quad Relay Bricklet
          - IO-16 Bricklet
          - IO-4 Bricklet
          - Joystick Bricklet
          - LCD 16x2 Bricklet
          - LCD 20x4 Bricklet
          - LED Strip Bricklet
          - Line Bricklet
          - Linear Poti Bricklet
          - Moisture Bricklet
          - Motion Detector Bricklet
          - Multi Touch Bricklet
          - NFC/RFID Bricklet
          - Piezo Buzzer Bricklet
          - Piezo Speaker Bricklet
          - PTC Bricklet
          - Remote Switch Bricklet
          - Rotary Encoder Bricklet
          - Rotary Poti Bricklet
          - Segment Display 4x7 Bricklet
          - Solid State Relay Bricklet
          - Sound Intensity Bricklet
          - Temperature Bricklet
          - Temperature IR Bricklet
          - Tilt Bricklet
          - Voltage Bricklet
          - Voltage/Current Bricklet
    - C# (Windows Phone)
    - Delphi/Lazarus
    - Java
    - Java (Android)
    - JavaScript
    - LabVIEW
    - Mathematica
    - MATLAB/Octave
    - Perl
    - PHP
    - Python
    - Ruby
    - Shell
    - Visual Basic .NET
  - 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

# C# - Ambient Light Bricklet

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

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

## Examples

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

### Simple

Download (ExampleSimple.cs)

     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

    using Tinkerforge;

    class Example
    {
        private static string HOST = "localhost";
        private static int PORT = 4223;
        private static string UID = "ABC"; // Change to your UID

        static void Main()
        {
            IPConnection ipcon = new IPConnection(); // Create IP connection
            BrickletAmbientLight al = new BrickletAmbientLight(UID, ipcon); // Create device object

            ipcon.Connect(HOST, PORT); // Connect to brickd
            // Don't use device before ipcon is connected

            // Get current illuminance (unit is Lux/10)
            int illuminance = al.GetIlluminance();

            System.Console.WriteLine("Illuminance: " + illuminance/10.0 + " Lux");

            System.Console.WriteLine("Press enter to exit");
            System.Console.ReadLine();
            ipcon.Disconnect();
        }
    }

### Callback

Download (ExampleCallback.cs)

     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
    35

    using Tinkerforge;

    class Example
    {
        private static string HOST = "localhost";
        private static int PORT = 4223;
        private static string UID = "ABC"; // Change to your UID

        // Callback function for illuminance callback (parameter has unit Lux/10)
        static void IlluminanceCB(BrickletAmbientLight sender, int illuminance)
        {
            System.Console.WriteLine("Illuminance: " + illuminance/10.0 + " Lux");
        }

        static void Main()
        {
            IPConnection ipcon = new IPConnection(); // Create IP connection
            BrickletAmbientLight al = new BrickletAmbientLight(UID, ipcon); // Create device object

            ipcon.Connect(HOST, PORT); // Connect to brickd
            // Don't use device before ipcon is connected

            // 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);

            // Register illuminance callback to function IlluminanceCB
            al.Illuminance += IlluminanceCB;

            System.Console.WriteLine("Press enter to exit");
            System.Console.ReadLine();
            ipcon.Disconnect();
        }
    }

### Threshold

Download (ExampleThreshold.cs)

     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
    35
    36
    37

    using Tinkerforge;

    class Example
    {
        private static string HOST = "localhost";
        private static int PORT = 4223;
        private static string UID = "ABC"; // Change to your UID

        // Callback for illuminance greater than 200 Lux
        static void ReachedCB(BrickletAmbientLight sender, int illuminance)
        {
            System.Console.WriteLine("We have " + illuminance/10.0 + " Lux.");
            System.Console.WriteLine("Too bright, close the curtains!");
        }

        static void Main()
        {
            IPConnection ipcon = new IPConnection(); // Create IP connection
            BrickletAmbientLight al = new BrickletAmbientLight(UID, ipcon); // Create device object

            ipcon.Connect(HOST, PORT); // Connect to brickd
            // Don't use device before ipcon is connected

            // Get threshold callbacks with a debounce time of 10 seconds (10000ms)
            al.SetDebouncePeriod(10000);

            // Register threshold reached callback to function ReachedCB
            al.IlluminanceReached += ReachedCB;

            // Configure threshold for "greater than 200 Lux" (unit is Lux/10)
            al.SetIlluminanceCallbackThreshold('>', 200*10, 0);

            System.Console.WriteLine("Press enter to exit");
            System.Console.ReadLine();
            ipcon.Disconnect();
        }
    }

## API

Generally, every method of the C# 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 C# does not support multiple return values directly, we use the `out` keyword to return multiple values from a method.

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

All methods listed below are thread-safe.

### Basic Functions

public class `BrickletAmbientLight`(String uid, IPConnection ipcon)

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

      BrickletAmbientLight ambientLight = new BrickletAmbientLight("YOUR_DEVICE_UID", ipcon);

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

public int `GetIlluminance`()

  Returns the illuminance of the ambient light sensor. The value has a range of 0 to 9000 and is given in Lux/10, i.e. a value of 4500 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

public int `GetAnalogValue`()

  Returns the value as read by a 12-bit analog-to-digital converter. The value is between 0 and 4095.

  Note

  The value returned by `GetIlluminance()` is averaged over several samples to yield less noise, while `GetAnalogValue()` gives back raw unfiltered analog values. The only reason to use `GetAnalogValue()` is, if you need the full resolution of the analog-to-digital converter.

  Also, the analog-to-digital converter covers three different ranges that are set dynamically depending on the light intensity. It is impossible to distinguish between these ranges with the analog value.

  If you want the analog value periodically, it is recommended to use the callback `AnalogValue` and set the period with `SetAnalogValueCallbackPeriod()`.

public byte[] `GetAPIVersion`()

  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.

public bool `GetResponseExpected`(byte functionId)

  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.

public void `SetResponseExpected`(byte functionId, bool responseExpected)

  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:

  - BrickletAmbientLight.FUNCTION_SET_ILLUMINANCE_CALLBACK_PERIOD = 3
  - BrickletAmbientLight.FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 5
  - BrickletAmbientLight.FUNCTION_SET_ILLUMINANCE_CALLBACK_THRESHOLD = 7
  - BrickletAmbientLight.FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 9
  - BrickletAmbientLight.FUNCTION_SET_DEBOUNCE_PERIOD = 11

public void `SetResponseExpectedAll`(bool responseExpected)

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

public void `GetIdentity`(out string uid, out string connectedUid, out char position, out byte[] hardwareVersion, out byte[] firmwareVersion, out int deviceIdentifier)

  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

public void `SetIlluminanceCallbackPeriod`(long period)

  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.

public long `GetIlluminanceCallbackPeriod`()

  Returns the period as set by `SetIlluminanceCallbackPeriod()`.

public void `SetAnalogValueCallbackPeriod`(long period)

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

  `AnalogValue` is only triggered if the analog value has changed since the last triggering.

  The default value is 0.

public long `GetAnalogValueCallbackPeriod`()

  Returns the period as set by `SetAnalogValueCallbackPeriod()`.

public void `SetIlluminanceCallbackThreshold`(char option, short min, short max)

  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:

  - BrickletAmbientLight.THRESHOLD_OPTION_OFF = 'x'
  - BrickletAmbientLight.THRESHOLD_OPTION_OUTSIDE = 'o'
  - BrickletAmbientLight.THRESHOLD_OPTION_INSIDE = 'i'
  - BrickletAmbientLight.THRESHOLD_OPTION_SMALLER = '<'
  - BrickletAmbientLight.THRESHOLD_OPTION_GREATER = '>'

public void `GetIlluminanceCallbackThreshold`(out char option, out short min, out short max)

  Returns the threshold as set by `SetIlluminanceCallbackThreshold()`.

  The following constants are available for this function:

  - BrickletAmbientLight.THRESHOLD_OPTION_OFF = 'x'
  - BrickletAmbientLight.THRESHOLD_OPTION_OUTSIDE = 'o'
  - BrickletAmbientLight.THRESHOLD_OPTION_INSIDE = 'i'
  - BrickletAmbientLight.THRESHOLD_OPTION_SMALLER = '<'
  - BrickletAmbientLight.THRESHOLD_OPTION_GREATER = '>'

public void `SetAnalogValueCallbackThreshold`(char option, int min, int max)

  Sets the thresholds for the `AnalogValueReached` callback.

  The following options are possible:

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

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

  The following constants are available for this function:

  - BrickletAmbientLight.THRESHOLD_OPTION_OFF = 'x'
  - BrickletAmbientLight.THRESHOLD_OPTION_OUTSIDE = 'o'
  - BrickletAmbientLight.THRESHOLD_OPTION_INSIDE = 'i'
  - BrickletAmbientLight.THRESHOLD_OPTION_SMALLER = '<'
  - BrickletAmbientLight.THRESHOLD_OPTION_GREATER = '>'

public void `GetAnalogValueCallbackThreshold`(out char option, out int min, out int max)

  Returns the threshold as set by `SetAnalogValueCallbackThreshold()`.

  The following constants are available for this function:

  - BrickletAmbientLight.THRESHOLD_OPTION_OFF = 'x'
  - BrickletAmbientLight.THRESHOLD_OPTION_OUTSIDE = 'o'
  - BrickletAmbientLight.THRESHOLD_OPTION_INSIDE = 'i'
  - BrickletAmbientLight.THRESHOLD_OPTION_SMALLER = '<'
  - BrickletAmbientLight.THRESHOLD_OPTION_GREATER = '>'

public void `SetDebouncePeriod`(long debounce)

  Sets the period in ms with which the threshold callbacks

  - `IlluminanceReached`,
  - `AnalogValueReached`

  are triggered, if the thresholds

  - `SetIlluminanceCallbackThreshold()`,
  - `SetAnalogValueCallbackThreshold()`

  keep being reached.

  The default value is 100.

public long `GetDebouncePeriod`()

  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 appending your callback handler to the corresponding event:

    void Callback(BrickletAmbientLight sender, int value)
    {
        System.Console.WriteLine("Value: " + value);
    }

    ambientLight.ExampleCallback += Callback;

The available events 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.

public event `Illuminance`(BrickletAmbientLight sender, int illuminance)

  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.

public event `AnalogValue`(BrickletAmbientLight sender, int value)

  This callback is triggered periodically with the period that is set by `SetAnalogValueCallbackPeriod()`. The parameter is the analog value of the ambient light sensor.

  `AnalogValue` is only triggered if the analog value has changed since the last triggering.

public event `IlluminanceReached`(BrickletAmbientLight sender, int illuminance)

  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()`.

public event `AnalogValueReached`(BrickletAmbientLight sender, int value)

  This callback is triggered when the threshold as set by `SetAnalogValueCallbackThreshold()` is reached. The parameter is the analog value of the ambient light sensor.

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

### Constants

public int `DEVICE_IDENTIFIER`

  This constant is used to identify a Ambient Light Bricklet.

  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.