LedSetMessage.hh

Go to the documentation of this file.

#ifndef LibMultiSense_LedSetMessage
#define LibMultiSense_LedSetMessage

#include "MultiSense/details/utility/Portability.hh"

namespace crl {
namespace multisense {
namespace details {
namespace wire {

class LedSet {
public:
    static CRL_CONSTEXPR IdType      ID      = ID_CMD_LED_SET;
    static CRL_CONSTEXPR VersionType VERSION = 4;

    //
    // Bit mask selecting which LEDs to update

    uint8_t mask;

    //
    // LED duty cycles; 0 = off; 255 = 100%

    uint8_t intensity[lighting::MAX_LIGHTS];

    //
    // If non-zero, LEDs are only on while sensors are exposing

    uint8_t flash;

    //
    // The delay of the LED from turning on to visible light seen in microseconds.
    // Should be measured and specific to the LED in question.

    uint32_t led_delay_us;

    //
    // For LED synchronized to shutter the number of pulses is how many pulses
    // per exposure of an image.

    uint32_t number_of_pulses;

    //
    // Invert the output signal that drives lighting. 1 means the output
    // will be low during the exposure. 0 means the output will be high
    // during the exposure.

    uint8_t invert_pulse;

    //
    // Used to enable the rolling shutter led feature, applicable for cameras
    // with a rolling shutter imager.

    uint8_t rolling_shutter_led;

    //
    // Constructors

    LedSet(utility::BufferStreamReader&r, VersionType v) {serialize(r,v);};
    LedSet() : mask(0), flash(0), led_delay_us(0), number_of_pulses(1),
    invert_pulse(0), rolling_shutter_led(0) {};

    //
    // Serialization routine

    template <class Archiver>
        void serialize(Archiver& archive,
                       const VersionType version)
    {
        (void) version;
        archive & mask;
        for(uint32_t i=0; i<lighting::MAX_LIGHTS; i++)
            archive & intensity[i];
        archive & flash;

        if (version >= 2)
        {
          archive & led_delay_us;
          archive & number_of_pulses;
        }
        else
        {
          led_delay_us = 0;
          number_of_pulses = 1;
        }

        if (version >= 3)
        {
          archive & invert_pulse;
        }
        else
        {
          invert_pulse = 0;
        }

        if (version >= 4)
        {
          archive & rolling_shutter_led;
        }
        else
        {
          rolling_shutter_led = 0;
        }
    }
};

}}}} // namespaces

#endif