Public Member Functions | Public Attributes | List of all members
crl::multisense::system::StatusMessage Class Reference

#include <MultiSenseTypes.hh>

Public Member Functions

 StatusMessage ()
 

Public Attributes

bool camerasOk
 
bool externalLedsOk
 
float fpgaPower
 
float fpgaTemperature
 
float imagerPower
 
bool imuOk
 
float inputCurrent
 
float inputVoltage
 
bool laserMotorOk
 
bool laserOk
 
float leftImagerTemperature
 
float logicPower
 
float powerSupplyTemperature
 
bool processingPipelineOk
 
float rightImagerTemperature
 
bool systemOk
 
double uptime
 

Detailed Description

Class containing status information for a particular device. This should be queried in a loop timed at 1Hz

Example code to query a single sensor's status:

//
// Instantiate a channel connecting to a sensor at the factory default
// IP address
channel = crl::multisense::Channel::Create("10.66.171.21");
channel->setMtu(1500);
//
// Create a instance of StatusMessage to store the sensor's status
//
// Query the network configuration from the Channel instance
crl::multisense::Status status = channel->getDeviceStatus(statusMessage);
//
// Check to see if the network configuration query succeeded
throw std::runtime_error("Unable to query sensor's status");
}
//
// Use the device status...
//
// Destroy the channel instance

Definition at line 3496 of file Legacy/include/MultiSense/MultiSenseTypes.hh.

Constructor & Destructor Documentation

◆ StatusMessage()

crl::multisense::system::StatusMessage::StatusMessage ( )
inline

Default constructor for a single StatusMessage object

Definition at line 3560 of file Legacy/include/MultiSense/MultiSenseTypes.hh.

Member Data Documentation

◆ camerasOk

bool crl::multisense::system::StatusMessage::camerasOk

A boolean flag indicating if the imagers are functioning. True corresponds to healthy

Definition at line 3517 of file Legacy/include/MultiSense/MultiSenseTypes.hh.

◆ externalLedsOk

bool crl::multisense::system::StatusMessage::externalLedsOk

A boolean flag indicating if the external LEDs are OK. This flag will only be true if external LEDs are present

Definition at line 3525 of file Legacy/include/MultiSense/MultiSenseTypes.hh.

◆ fpgaPower

float crl::multisense::system::StatusMessage::fpgaPower

The power consumed by the FPGA. Value is in Watts

Definition at line 3551 of file Legacy/include/MultiSense/MultiSenseTypes.hh.

◆ fpgaTemperature

float crl::multisense::system::StatusMessage::fpgaTemperature

The temperature of the FPGA. Temperature is is Celsius

Definition at line 3535 of file Legacy/include/MultiSense/MultiSenseTypes.hh.

◆ imagerPower

float crl::multisense::system::StatusMessage::imagerPower

The power consumed by the imager chips. Value is in Watts

Definition at line 3557 of file Legacy/include/MultiSense/MultiSenseTypes.hh.

◆ imuOk

bool crl::multisense::system::StatusMessage::imuOk

A boolean flag indicating if the imu is functioning. True corresponds to healthy

Definition at line 3521 of file Legacy/include/MultiSense/MultiSenseTypes.hh.

◆ inputCurrent

float crl::multisense::system::StatusMessage::inputCurrent

The current drawn from the input power supply by the MultiSense. Value is in Amperes

Definition at line 3548 of file Legacy/include/MultiSense/MultiSenseTypes.hh.

◆ inputVoltage

float crl::multisense::system::StatusMessage::inputVoltage

The input voltage supplied to the MultiSense. Value is in Volts

Definition at line 3544 of file Legacy/include/MultiSense/MultiSenseTypes.hh.

◆ laserMotorOk

bool crl::multisense::system::StatusMessage::laserMotorOk

A boolean flag indicating if the laser motor controller is functioning. True corresponds to healthy

Definition at line 3513 of file Legacy/include/MultiSense/MultiSenseTypes.hh.

◆ laserOk

bool crl::multisense::system::StatusMessage::laserOk

A boolean flag indicating if the laser is functioning. True corresponds to healthy

Definition at line 3509 of file Legacy/include/MultiSense/MultiSenseTypes.hh.

◆ leftImagerTemperature

float crl::multisense::system::StatusMessage::leftImagerTemperature

The temperature of the left imager. Temperature is is Celsius

Definition at line 3538 of file Legacy/include/MultiSense/MultiSenseTypes.hh.

◆ logicPower

float crl::multisense::system::StatusMessage::logicPower

The power consumed by the MicroBlaze CPU. Value is in Watts

Definition at line 3554 of file Legacy/include/MultiSense/MultiSenseTypes.hh.

◆ powerSupplyTemperature

float crl::multisense::system::StatusMessage::powerSupplyTemperature

The temperature of the internal switching mode power supply. Temperature is is Celsius

Definition at line 3532 of file Legacy/include/MultiSense/MultiSenseTypes.hh.

◆ processingPipelineOk

bool crl::multisense::system::StatusMessage::processingPipelineOk

A boolean indicating if the processing pipeline is ok

Definition at line 3528 of file Legacy/include/MultiSense/MultiSenseTypes.hh.

◆ rightImagerTemperature

float crl::multisense::system::StatusMessage::rightImagerTemperature

The temperature of the right imager. Temperature is is Celsius

Definition at line 3541 of file Legacy/include/MultiSense/MultiSenseTypes.hh.

◆ systemOk

bool crl::multisense::system::StatusMessage::systemOk

A boolean flag indicating if the overall system status is good. True corresponds to healthy

Definition at line 3505 of file Legacy/include/MultiSense/MultiSenseTypes.hh.

◆ uptime

double crl::multisense::system::StatusMessage::uptime

The system uptime of the MultiSense in seconds. True corresponds to healthy

Definition at line 3501 of file Legacy/include/MultiSense/MultiSenseTypes.hh.


The documentation for this class was generated from the following file:
crl::multisense::Status_Ok
static CRL_CONSTEXPR Status Status_Ok
Definition: Legacy/include/MultiSense/MultiSenseTypes.hh:99
crl::multisense::Channel::Destroy
static void Destroy(Channel *instanceP)
Definition: Legacy/details/channel.cc:863
crl::multisense::Channel::setMtu
virtual Status setMtu(int32_t mtu)=0
crl::multisense::Channel::getDeviceStatus
virtual Status getDeviceStatus(system::StatusMessage &status)=0
crl::multisense::Channel::Create
static Channel * Create(const std::string &sensorAddress)
Definition: Legacy/details/channel.cc:817
crl::multisense::Status
int32_t Status
Definition: Legacy/include/MultiSense/MultiSenseTypes.hh:94
crl::multisense::Channel
Definition: Legacy/include/MultiSense/MultiSenseChannel.hh:69
crl::multisense::system::StatusMessage
Definition: Legacy/include/MultiSense/MultiSenseTypes.hh:3496


multisense_lib
Author(s):
autogenerated on Thu Apr 17 2025 02:49:10