sick_scan_api.py

Go to the documentation of this file.

"""This file declares the functions and datatypes of the sick_scan_xd python-API.
 
See doc/sick_scan_api/sick_scan_api.md for further information.
 
"""
 
import ctypes
import numpy as np
import os
from enum import Enum
 
""" 
Message definitions
""" 
 
class SickScanHeader(ctypes.Structure):
    """ 
    sick_scan_api: struct SickScanHeader, equivalent to ros::std_msgs::Header
 
    Attributes
    ----------
    seq : ctypes.c_uint32
        sequence ID: consecutively increasing ID
    timestamp_sec : ctypes.c_uint32
        seconds part of message timestamps: seconds (stamp_secs) since epoch (in Python the variable is called 'secs')
    timestamp_nsec : ctypes.c_uint32
        seconds part of message timestamps: nanoseconds since stamp_secs (in Python the variable is called 'nsecs')
    frame_id : ctypes.c_char * 256
        Frame this data is associated with
    """
    _fields_ = [
        ("seq", ctypes.c_uint32),                    # sequence ID: consecutively increasing ID
        ("timestamp_sec", ctypes.c_uint32),          # seconds part of message timestamps: seconds (stamp_secs) since epoch (in Python the variable is called 'secs')
        ("timestamp_nsec", ctypes.c_uint32),         # seconds part of message timestamps: nanoseconds since stamp_secs (in Python the variable is called 'nsecs')
        ("frame_id", ctypes.c_char * 256)            # Frame this data is associated with
    ]
 
class SickScanUint8Array(ctypes.Structure):
    """ 
    equivalent to sick_scan_api.h struct SickScanUint8Array
 
    Attributes
    ----------
    capacity : ctypes.c_uint64
        Number of allocated elements, i.e. max. number of elements in buffer, allocated buffer size is capacity * sizeof(SickScanPointFieldMsg)
    size : ctypes.c_uint64
        Number of currently used elements in the buffer
    buffer : ctypes.POINTER(ctypes.c_uint8)
        Memory, data in plain order and system endianess (buffer == 0, if size == 0 && capacity == 0, otherwise allocated memory), allocation/deallocation always managed by the caller.
    """
    _fields_ = [
        ("capacity", ctypes.c_uint64),               # Number of allocated elements, i.e. max. number of elements in buffer, allocated buffer size is capacity * sizeof(SickScanPointFieldMsg)
        ("size", ctypes.c_uint64),                   # Number of currently used elements in the buffer
        ("buffer", ctypes.POINTER(ctypes.c_uint8))   # Memory, data in plain order and system endianess (buffer == 0, if size == 0 && capacity == 0, otherwise allocated memory), allocation/deallocation always managed by the caller.
    ]
 
class SickScanNativeDataType(Enum):
    """ 
    This message holds the description of one point entry in the PointCloud2 message format, equivalent to type enum im ros::sensor_msgs::PointField
    """
    SICK_SCAN_POINTFIELD_DATATYPE_INT8    = 1, "SICK_SCAN_POINTFIELD_DATATYPE_INT8"
    SICK_SCAN_POINTFIELD_DATATYPE_UINT8   = 2, "SICK_SCAN_POINTFIELD_DATATYPE_UINT8"
    SICK_SCAN_POINTFIELD_DATATYPE_INT16   = 3, "SICK_SCAN_POINTFIELD_DATATYPE_INT16"
    SICK_SCAN_POINTFIELD_DATATYPE_UINT16  = 4, "SICK_SCAN_POINTFIELD_DATATYPE_UINT16"
    SICK_SCAN_POINTFIELD_DATATYPE_INT32   = 5, "SICK_SCAN_POINTFIELD_DATATYPE_INT32"
    SICK_SCAN_POINTFIELD_DATATYPE_UINT32  = 6, "SICK_SCAN_POINTFIELD_DATATYPE_UINT32"
    SICK_SCAN_POINTFIELD_DATATYPE_FLOAT32 = 7, "SICK_SCAN_POINTFIELD_DATATYPE_FLOAT32"
    SICK_SCAN_POINTFIELD_DATATYPE_FLOAT64 = 8, "SICK_SCAN_POINTFIELD_DATATYPE_FLOAT64"
    def __int__(self):
        return self.value[0]
    def __str__(self):
        return self.value[1]
 
 
class SickScanPointFieldMsg(ctypes.Structure):
    """ 
    sick_scan_api: struct SickScanPointFieldMsg, equivalent to ros::sensor_msgs::PointField
    SickScanPointFieldArray is an array of SickScanPointFieldMsg, which defines the structure of the binary data of a SickScanPointCloudMsg.
    SickScanPointFieldMsg for pointclouds in cartesian coordinates with fields (x, y, z, intensity):
        [ SickScanPointFieldMsg(name="x", offset=0, datatype=FLOAT32, count=1), 
          SickScanPointFieldMsg(name="y", offset=4, datatype=FLOAT32, count=1),
          SickScanPointFieldMsg(name="z", offset=8, datatype=FLOAT32, count=1),
          SickScanPointFieldMsg(name="intensity", offset=12, datatype=FLOAT32, count=1) ]
    SickScanPointFieldMsg for pointclouds in polar coordinates with fields (range, azimuth, elevation, intensity):
        [ SickScanPointFieldMsg(name="range", offset=0, datatype=FLOAT32, count=1), 
          SickScanPointFieldMsg(name="azimuth", offset=4, datatype=FLOAT32, count=1),
          SickScanPointFieldMsg(name="elevation", offset=8, datatype=FLOAT32, count=1),
          SickScanPointFieldMsg(name="intensity", offset=12, datatype=FLOAT32, count=1) ]
 
    Attributes
    ----------
    name : ctypes.c_char * 256
        Name of field (max. length 256 characters)
    offset : ctypes.c_uint32
        Offset from start of point struct
    datatype : ctypes.c_uint8
        Datatype enumeration, see SickScanNativeDataType, equivalent to type enum im ros::sensor_msgs::PointField
    count : ctypes.c_uint32
        How many elements in the field
    """
    _fields_ = [
        ("name", ctypes.c_char * 256),               # Name of field (max. length 256 characters)
        ("offset", ctypes.c_uint32),                 # Offset from start of point struct
        ("datatype", ctypes.c_uint8),                # Datatype enumeration, see SickScanNativeDataType, equivalent to type enum im ros::sensor_msgs::PointField
        ("count", ctypes.c_uint32)                   # How many elements in the field
   ]
 
class SickScanPointFieldArray(ctypes.Structure):
    """ 
    sick_scan_api: struct SickScanPointFieldArray, Array of SickScanPointFieldMsg, which can be serialized and imported in C, C++ or python
 
    Attributes
    ----------
    capacity : ctypes.c_uint64
        Number of allocated elements, i.e. max. number of elements in buffer, allocated buffer size is capacity * sizeof(SickScanPointFieldMsg)
    size : ctypes.c_uint64
        Number of currently used elements in the buffer
    buffer : ctypes.POINTER(SickScanPointFieldMsg)
        Memory, data in plain order and system endianess (buffer == 0, if size == 0 && capacity == 0, otherwise allocated memory), allocation/deallocation always managed by the caller.
    """
    _fields_ = [
        ("capacity", ctypes.c_uint64),                     # Number of allocated elements, i.e. max. number of elements in buffer, allocated buffer size is capacity * sizeof(SickScanPointFieldMsg)
        ("size", ctypes.c_uint64),                         # Number of currently used elements in the buffer
        ("buffer", ctypes.POINTER(SickScanPointFieldMsg))  # Memory, data in plain order and system endianess (buffer == 0, if size == 0 && capacity == 0, otherwise allocated memory), allocation/deallocation always managed by the caller.
    ]
 
class SickScanPointCloudMsg(ctypes.Structure):
    """ 
    sick_scan_api: struct SickScanPointCloudMsg, equivalent to ros::std_msgs::PointCloud2
    SickScanPointCloudMsg contains the polar or cartesian pointcloud data.
    A SickScanPointCloudMsg in cartesian coordinates has fields (x, y, z, intensity).
    A SickScanPointCloudMsg in polar coordinates has fields (range, azimuth, elevation, intensity).
    Note: The pointcloud contains always <num_echos> echos. Invalid echos are filled with 0 values in the data array.
 
    Attributes
    ----------
    header : SickScanHeader
        message timestamp
    height : ctypes.c_uint32
        2D structure of the point cloud. If the cloud is unordered, height is 1
    width : ctypes.c_uint32
        and width is the length of the point cloud.
    fields : SickScanPointFieldArray
        Describes the channels and their layout in the binary data blob.
    is_bigendian : ctypes.c_uint8
        Is this data bigendian?
    point_step : ctypes.c_uint32
        Length of a point in bytes
    row_step : ctypes.c_uint32
        Length of a row in bytes
    data : SickScanUint8Array
        Actual point data, size is (row_step*height)
    is_dense : ctypes.c_uint8
        True if there are no invalid points
    num_echos : ctypes.c_int32
        number of echos
    segment_idx : ctypes.c_int32
        segment index (or -1 if pointcloud contains data from multiple segments)
    """
    _fields_ = [
        ("header", SickScanHeader),                  # message timestamp
        ("height", ctypes.c_uint32),                 # 2D structure of the point cloud. If the cloud is unordered, height is 1
        ("width", ctypes.c_uint32),                  # and width is the length of the point cloud.
        ("fields", SickScanPointFieldArray),         # Describes the channels and their layout in the binary data blob.
        ("is_bigendian", ctypes.c_uint8),            # Is this data bigendian?
        ("point_step", ctypes.c_uint32),             # Length of a point in bytes
        ("row_step", ctypes.c_uint32),               # Length of a row in bytes
        ("data", SickScanUint8Array),                # Actual point data, size is (row_step*height)
        ("is_dense", ctypes.c_uint8),                # True if there are no invalid points
        ("num_echos", ctypes.c_int32),               # number of echos
        ("segment_idx", ctypes.c_int32),             # segment index (or -1 if pointcloud contains data from multiple segments)
        ("topic", ctypes.c_char * 256)               # ros topic this pointcloud is published
   ]
 
class SickScanVector3Msg(ctypes.Structure):
    """ 
    sick_scan_api: struct SickScanVector3Msg, equivalent to geometry_msgs/Vector3
 
    Attributes
    ----------
    x : ctypes.c_double
    y : ctypes.c_double
    z : ctypes.c_double
    """
    _fields_ = [
        ("x", ctypes.c_double),
        ("y", ctypes.c_double),
        ("z", ctypes.c_double)
    ]
 
class SickScanQuaternionMsg(ctypes.Structure):
    """ 
    sick_scan_api: struct SickScanQuaternionMsg, equivalent to geometry_msgs/Quaternion
 
    Attributes
    ----------
    x : ctypes.c_double
    y : ctypes.c_double
    z : ctypes.c_double
    w : ctypes.c_double
    """
    _fields_ = [
        ("x", ctypes.c_double),
        ("y", ctypes.c_double),
        ("z", ctypes.c_double),
        ("w", ctypes.c_double)
    ]
 
class SickScanPointArray(ctypes.Structure):
    """ 
    sick_scan_api: struct SickScanPointArray, Array of SickScanVector3Msg, which can be serialized and imported in C, C++ or python
 
    Attributes
    ----------
    capacity : ctypes.c_uint64
        Number of allocated elements, i.e. max. number of elements in buffer, allocated buffer size is capacity * sizeof(SickScanVector3Msg)
    size : ctypes.c_uint64
        Number of currently used elements in the buffer
    buffer : ctypes.POINTER(SickScanVector3Msg)
        Memory, data in plain order and system endianess (buffer == 0, if size == 0 && capacity == 0, otherwise allocated memory), allocation/deallocation always managed by the caller.
    """
    _fields_ = [
        ("capacity", ctypes.c_uint64), # Number of allocated elements, i.e. max. number of elements in buffer, allocated buffer size is capacity * sizeof(SickScanVector3Msg)
        ("size", ctypes.c_uint64),     # Number of currently used elements in the buffer
        ("buffer", ctypes.POINTER(SickScanVector3Msg))  # Memory, data in plain order and system endianess (buffer == 0, if size == 0 && capacity == 0, otherwise allocated memory), allocation/deallocation always managed by the caller.
    ]
 
class SickScanImuMsg(ctypes.Structure):
    """ 
    sick_scan_api: struct SickScanImuMsg, equivalent to ros sensor_msgs::Imu
 
    Attributes
    ----------
    header : SickScanHeader
        message timestamp
    orientation : SickScanQuaternionMsg
    orientation_covariance : ctypes.c_double * 9
        Row major about x, y, z axes
    angular_velocity : SickScanVector3Msg
    angular_velocity_covariance : ctypes.c_double * 9
        Row major about x, y, z axes
    linear_acceleration : SickScanVector3Msg
    linear_acceleration_covariance : ctypes.c_double * 9
        Row major x, y z
    """
    _fields_ = [
        ("header", SickScanHeader),                              # message timestamp
        ("orientation", SickScanQuaternionMsg),
        ("orientation_covariance", ctypes.c_double * 9),         # Row major about x, y, z axes
        ("angular_velocity", SickScanVector3Msg),
        ("angular_velocity_covariance", ctypes.c_double * 9),    # Row major about x, y, z axes
        ("linear_acceleration", SickScanVector3Msg),
        ("linear_acceleration_covariance", ctypes.c_double * 9)  # Row major x, y z
    ]
 
class SickScanLFErecFieldMsg(ctypes.Structure):
    """ 
    sick_scan_api: struct SickScanLFErecFieldMsg, equivalent to LFErecFieldMsg.msg
 
    Attributes
    ----------
    version_number : ctypes.c_uint16
    field_index : ctypes.c_uint8
    sys_count : ctypes.c_uint32
    dist_scale_factor : ctypes.c_float
    dist_scale_offset : ctypes.c_float
    angle_scale_factor : ctypes.c_uint32
    angle_scale_offset : ctypes.c_int32
    field_result_mrs : ctypes.c_uint8
        field result is 0 (invalid/incorrect), 1 (free/clear) or 2 (infringed)
    time_state : ctypes.c_uint16
        No time data: 0, Time data: 1
    year : ctypes.c_uint16
        f.e. 2021
    month : ctypes.c_uint8
        1 ... 12
    day : ctypes.c_uint8
        1 ... 31
    hour : ctypes.c_uint8
        0 ... 23
    minute : ctypes.c_uint8
        0 ... 59
    second : ctypes.c_uint8
        0 ... 59
    microsecond : ctypes.c_uint32
        0 ... 999999
    """
    _fields_ = [
        ("version_number", ctypes.c_uint16),
        ("field_index", ctypes.c_uint8),
        ("sys_count", ctypes.c_uint32),
        ("dist_scale_factor", ctypes.c_float),
        ("dist_scale_offset", ctypes.c_float),
        ("angle_scale_factor", ctypes.c_uint32),
        ("angle_scale_offset", ctypes.c_int32),
        ("field_result_mrs", ctypes.c_uint8),        # field result is 0 (invalid/incorrect), 1 (free/clear) or 2 (infringed)
        ("time_state", ctypes.c_uint16),             # No time data: 0, Time data: 1
        ("year", ctypes.c_uint16),                   # f.e. 2021
        ("month", ctypes.c_uint8),                   # 1 ... 12
        ("day", ctypes.c_uint8),                     # 1 ... 31
        ("hour", ctypes.c_uint8),                    # 0 ... 23
        ("minute", ctypes.c_uint8),                  # 0 ... 59
        ("second", ctypes.c_uint8),                  # 0 ... 59
        ("microsecond", ctypes.c_uint32)             # 0 ... 999999
    ]
 
class SickScanLFErecMsg(ctypes.Structure):
    """ 
    sick_scan_api: struct SickScanLFErecMsg, equivalent to LFErecMsg.msg
 
    Attributes
    ----------
    header : SickScanHeader
        message timestamp
    fields_number : ctypes.c_uint16
        number of valid fields
    fields : SickScanLFErecFieldMsg * 3
        max. 3 valid fields
    """
    _fields_ = [
        ("header", SickScanHeader),                  # message timestamp
        ("fields_number", ctypes.c_uint16),          # number of valid fields
        ("fields", SickScanLFErecFieldMsg * 3)       # max. 3 valid fields
    ]
 
class SickScanLIDoutputstateMsg(ctypes.Structure):
    """ 
    sick_scan_api: struct SickScanLIDoutputstateMsg, equivalent to LIDoutputstateMsg.msg
 
    Attributes
    ----------
    header : SickScanHeader
        message timestamp
    version_number : ctypes.c_uint16
        Status code version number
    system_counter : ctypes.c_uint32
        Status code system counter (time in microsec since power up, max. 71 min then starting from 0 again)
    output_state : ctypes.c_uint8 * 8
        array of max. 8 output states, each state with value 0 (not active), 1 (active) or 2 (not used)
    output_count : ctypes.c_uint32 * 8
        array of max. 8 output counter
    time_state : ctypes.c_uint16
        No time data: 0, Time data: 1 (sensortime from the last change of min. one of the outputs)
    year : ctypes.c_uint16
        f.e. 2021
    month : ctypes.c_uint8
        1 ... 12
    day : ctypes.c_uint8
        1 ... 31
    hour : ctypes.c_uint8
        0 ... 23
    minute : ctypes.c_uint8
        0 ... 59
    second : ctypes.c_uint8
        0 ... 59
    microsecond : ctypes.c_uint32
        0 ... 999999
    """
    _fields_ = [
        ("header", SickScanHeader),                  # message timestamp
        ("version_number", ctypes.c_uint16),         # Status code version number
        ("system_counter", ctypes.c_uint32),         # Status code system counter (time in microsec since power up, max. 71 min then starting from 0 again)
        ("output_state", ctypes.c_uint8 * 8),        # array of max. 8 output states, each state with value 0 (not active), 1 (active) or 2 (not used)
        ("output_count", ctypes.c_uint32 * 8),       # array of max. 8 output counter
        ("time_state", ctypes.c_uint16),             # No time data: 0, Time data: 1 (sensortime from the last change of min. one of the outputs)
        ("year", ctypes.c_uint16),                   # f.e. 2021
        ("month", ctypes.c_uint8),                   # 1 ... 12
        ("day", ctypes.c_uint8),                     # 1 ... 31
        ("hour", ctypes.c_uint8),                    # 0 ... 23
        ("minute", ctypes.c_uint8),                  # 0 ... 59
        ("second", ctypes.c_uint8),                  # 0 ... 59
        ("microsecond", ctypes.c_uint32)             # 0 ... 999999
    ]
 
class SickScanRadarPreHeader(ctypes.Structure):
    """ 
    sick_scan_api: struct SickScanRadarPreHeader, equivalent to RadarPreHeader.msg
 
    Attributes
    ----------
    uiversionno : ctypes.c_uint16
        version number
    sick_scan/RadarPreHeaderDeviceBlock:
    uiident : ctypes.c_uint32
        Logical number of the device"
    udiserialno : ctypes.c_uint32
        Serial number of the device
    bdeviceerror : ctypes.c_uint8
        State of the device
    bcontaminationwarning : ctypes.c_uint8
        Contamination Warning
    bcontaminationerror : ctypes.c_uint8
        Contamination Error
    sick_scan/RadarPreHeaderStatusBlock:
    uitelegramcount : ctypes.c_uint32
        telegram number
    uicyclecount : ctypes.c_uint32
        "scan number"
    udisystemcountscan : ctypes.c_uint32
        system time since power on of scan gen. [us]
    udisystemcounttransmit : ctypes.c_uint32
        system time since power on of scan transmission [us]
    uiinputs : ctypes.c_uint16
        state of digital inputs
    uioutputs : ctypes.c_uint16
        state of digital outputs
    sick_scan/RadarPreHeaderMeasurementParam1Block:
    uicycleduration : ctypes.c_uint32
        Time in microseconds to detect this items
    uinoiselevel : ctypes.c_uint32
        [1/100dB]
    sick_scan/RadarPreHeaderEncoderBlock[]:
    numencoder : ctypes.c_uint16
        number of valid encoders (0)
    udiencoderpos : ctypes.c_uint32 * 3
        array of max. 3 encoder position [inc]
    iencoderspeed : ctypes.c_uint16 * 3
        array of max. 3 encoder speed [inc/mm]
    """
    _fields_ = [
        ("uiversionno", ctypes.c_uint16),            # version number
        # sick_scan/RadarPreHeaderDeviceBlock:
        ("uiident", ctypes.c_uint32),                # Logical number of the device"
        ("udiserialno", ctypes.c_uint32),            # Serial number of the device
        ("bdeviceerror", ctypes.c_uint8),            # State of the device
        ("bcontaminationwarning", ctypes.c_uint8),   # Contamination Warning
        ("bcontaminationerror", ctypes.c_uint8),     # Contamination Error
        # sick_scan/RadarPreHeaderStatusBlock:
        ("uitelegramcount", ctypes.c_uint32),        # telegram number
        ("uicyclecount", ctypes.c_uint32),           # "scan number"
        ("udisystemcountscan", ctypes.c_uint32),     # system time since power on of scan gen. [us]
        ("udisystemcounttransmit", ctypes.c_uint32), # system time since power on of scan transmission [us]
        ("uiinputs", ctypes.c_uint16),               # state of digital inputs
        ("uioutputs", ctypes.c_uint16),              # state of digital outputs
        # sick_scan/RadarPreHeaderMeasurementParam1Block:
        ("uicycleduration", ctypes.c_uint32),        # Time in microseconds to detect this items
        ("uinoiselevel", ctypes.c_uint32),           # [1/100dB]
        # sick_scan/RadarPreHeaderEncoderBlock[]:
        ("numencoder", ctypes.c_uint16),             # number of valid encoders (0)
        ("udiencoderpos", ctypes.c_uint32 * 3),      # array of max. 3 encoder position [inc]
        ("iencoderspeed", ctypes.c_uint16 * 3)       # array of max. 3 encoder speed [inc/mm]
    ]
 
class SickScanRadarObject(ctypes.Structure):
    """ 
    sick_scan_api: struct SickScanRadarObject, equivalent to RadarObject.msg
 
    Attributes
    ----------
    id : ctypes.c_int32
    tracking_time_sec : ctypes.c_uint32
        seconds part of tracking_time (since when the object is tracked): seconds (stamp_secs) since epoch
    tracking_time_nsec : ctypes.c_uint32
        nanoseconds part of tracking_time (since when the object is tracked): nanoseconds since stamp_secs
    last_seen_sec : ctypes.c_uint32
        seconds part of last_seen timestamp: seconds (stamp_secs) since epoch
    last_seen_nsec : ctypes.c_uint32
        nanoseconds part of last_seen timestamp: nanoseconds since stamp_secs
    # geometry_msgs/TwistWithCovariance velocity
    velocity_linear : SickScanVector3Msg
    velocity_angular : SickScanVector3Msg
    velocity_covariance : ctypes.c_double * 36
        Row-major representation of the 6x6 covariance matrix (x, y, z, rotation about X axis, rotation about Y axis, rotation about Z axis)
    # geometry_msgs/Pose bounding_box_center
    bounding_box_center_position : SickScanVector3Msg
    bounding_box_center_orientation : SickScanQuaternionMsg
    geometry_msgs/Vector3 bounding_box_size
    bounding_box_size : SickScanVector3Msg
    # geometry_msgs/PoseWithCovariance object_box_center
    object_box_center_position : SickScanVector3Msg
    object_box_center_orientation : SickScanQuaternionMsg
    object_box_center_covariance : ctypes.c_double * 36
        Row-major representation of the 6x6 covariance matrix (x, y, z, rotation about X axis, rotation about Y axis, rotation about Z axis)
    # geometry_msgs/Vector3 object_box_size
    object_box_size : SickScanVector3Msg
    geometry_msgs/Point[] contour_points
    contour_points : SickScanPointArray)
    """
    _fields_ = [
        ("id", ctypes.c_int32),
        ("tracking_time_sec", ctypes.c_uint32),      # seconds part of tracking_time (since when the object is tracked): seconds (stamp_secs) since epoch
        ("tracking_time_nsec", ctypes.c_uint32),     # nanoseconds part of tracking_time (since when the object is tracked): nanoseconds since stamp_secs
        ("last_seen_sec", ctypes.c_uint32),          # seconds part of last_seen timestamp: seconds (stamp_secs) since epoch
        ("last_seen_nsec", ctypes.c_uint32),         # nanoseconds part of last_seen timestamp: nanoseconds since stamp_secs
        # geometry_msgs/TwistWithCovariance velocity
        ("velocity_linear", SickScanVector3Msg),
        ("velocity_angular", SickScanVector3Msg),
        ("velocity_covariance", ctypes.c_double * 36), # Row-major representation of the 6x6 covariance matrix (x, y, z, rotation about X axis, rotation about Y axis, rotation about Z axis)
        # geometry_msgs/Pose bounding_box_center
        ("bounding_box_center_position", SickScanVector3Msg),
        ("bounding_box_center_orientation", SickScanQuaternionMsg),
        # geometry_msgs/Vector3 bounding_box_size
        ("bounding_box_size", SickScanVector3Msg),
        # geometry_msgs/PoseWithCovariance object_box_center
        ("object_box_center_position", SickScanVector3Msg),
        ("object_box_center_orientation", SickScanQuaternionMsg),
        ("object_box_center_covariance", ctypes.c_double * 36), # Row-major representation of the 6x6 covariance matrix (x, y, z, rotation about X axis, rotation about Y axis, rotation about Z axis)
        # geometry_msgs/Vector3 object_box_size
        ("object_box_size", SickScanVector3Msg),
        # geometry_msgs/Point[] contour_points
        ("contour_points", SickScanPointArray)
    ]
 
class SickScanRadarObjectArray(ctypes.Structure):
    """ 
    sick_scan_api: struct SickScanRadarObjectArray, Array of SickScanRadarObject
 
    Attributes
    ----------
    capacity : ctypes.c_uint64
        Number of allocated elements, i.e. max. number of elements in buffer, allocated buffer size is capacity * sizeof(SickScanRadarObject)
    size : ctypes.c_uint64
        Number of currently used elements in the buffer
    buffer : ctypes.POINTER(SickScanRadarObject)
        Memory, data in plain order and system endianess (buffer == 0, if size == 0 && capacity == 0, otherwise allocated memory), allocation/deallocation always managed by the caller.
    """
    _fields_ = [
        ("capacity", ctypes.c_uint64),                  # Number of allocated elements, i.e. max. number of elements in buffer, allocated buffer size is capacity * sizeof(SickScanRadarObject)
        ("size", ctypes.c_uint64),                      # Number of currently used elements in the buffer
        ("buffer", ctypes.POINTER(SickScanRadarObject)) # Memory, data in plain order and system endianess (buffer == 0, if size == 0 && capacity == 0, otherwise allocated memory), allocation/deallocation always managed by the caller.
    ]
 
class SickScanRadarScan(ctypes.Structure):
    """ 
    sick_scan_api: struct SickScanRadarScan, equivalent to RadarScan.msg
 
    Attributes
    ----------
    header : SickScanHeader
        message timestamp
    radarpreheader : SickScanRadarPreHeader
        RadarPreHeader.msg
    targets : SickScanPointCloudMsg
        sensor_msgs/PointCloud2
    objects : SickScanRadarObjectArray
        Array of RadarObject.msg
    """
    _fields_ = [
        ("header", SickScanHeader),                  # message timestamp
        ("radarpreheader", SickScanRadarPreHeader),  # RadarPreHeader.msg
        ("targets", SickScanPointCloudMsg),          # sensor_msgs/PointCloud2
        ("objects", SickScanRadarObjectArray)        # Array of RadarObject.msg
    ]
 
class SickScanLdmrsObject(SickScanRadarObject):
    """ 
    sick_scan_api: struct SickScanLdmrsObject, equivalent to SickLdmrsObject.msg
    """
    pass
 
class SickScanLdmrsObjectBuffer(ctypes.Structure):
    """ 
    sick_scan_api: struct SickScanLdmrsObjectBuffer, Array of SickScanLdmrsObject
 
    Attributes
    ----------
    capacity : ctypes.c_uint64
        Number of allocated elements, i.e. max. number of elements in buffer, allocated buffer size is capacity * sizeof(SickScanLdmrsObject)
    size : ctypes.c_uint64
        Number of currently used elements in the buffer
    buffer : ctypes.POINTER(SickScanLdmrsObject)
        Memory, data in plain order and system endianess (buffer == 0, if size == 0 && capacity == 0, otherwise allocated memory), allocation/deallocation always managed by the caller.
    """
    _fields_ = [
        ("capacity", ctypes.c_uint64),                  # Number of allocated elements, i.e. max. number of elements in buffer, allocated buffer size is capacity * sizeof(SickScanLdmrsObject)
        ("size", ctypes.c_uint64),                      # Number of currently used elements in the buffer
        ("buffer", ctypes.POINTER(SickScanLdmrsObject)) # Memory, data in plain order and system endianess (buffer == 0, if size == 0 && capacity == 0, otherwise allocated memory), allocation/deallocation always managed by the caller.
    ]
 
class SickScanLdmrsObjectArray(ctypes.Structure):
    """ 
    sick_scan_api: struct SickScanLdmrsObjectArray, equivalent to SickLdmrsObjectArray.msg
 
    Attributes
    ----------
    header : SickScanHeader
        message timestamp
    objects : SickScanLdmrsObjectBuffer
        Array of SickScanLdmrsObjects
    """
    _fields_ = [
        ("header", SickScanHeader),                    # message timestamp
        ("objects", SickScanLdmrsObjectBuffer)         # Array of SickScanLdmrsObjects
    ]
 
class SickScanColorRGBA(ctypes.Structure):
    """ 
    equivalent to std_msgs::ColorRGBA
 
    Attributes
    ----------
    r : ctypes.c_float
    g : ctypes.c_float
    b : ctypes.c_float
    a : ctypes.c_float
    """
    _fields_ = [
        ("r", ctypes.c_float),
        ("g", ctypes.c_float),
        ("b", ctypes.c_float),
        ("a", ctypes.c_float)
    ]
 
class SickScanColorRGBAArray(ctypes.Structure):
    """ 
    Array of SickScanColorRGBA, which can be serialized and imported in C, C++ or python
 
    Attributes
    ----------
    capacity : ctypes.c_uint64
        Number of allocated elements, i.e. max. number of elements in buffer, allocated buffer size is capacity * sizeof(SickScanColorRGBA)
    size : ctypes.c_uint64
        Number of currently used elements in the buffer
    buffer : ctypes.POINTER(SickScanColorRGBA)
        Memory, data in plain order and system endianess (buffer == 0, if size == 0 && capacity == 0, otherwise allocated memory), allocation/deallocation always managed by the caller.
    """
    _fields_ = [
        ("capacity", ctypes.c_uint64),                   # Number of allocated elements, i.e. max. number of elements in buffer, allocated buffer size is capacity * sizeof(SickScanColorRGBA)
        ("size", ctypes.c_uint64),                       # Number of currently used elements in the buffer
        ("buffer", ctypes.POINTER(SickScanColorRGBA))    # Memory, data in plain order and system endianess (buffer == 0, if size == 0 && capacity == 0, otherwise allocated memory), allocation/deallocation always managed by the caller.
    ]
 
class SickScanVisualizationMarker(ctypes.Structure):
    """ 
    equivalent to visualization_msgs::Marker
 
    Attributes
    ----------
    header : SickScanHeader
        message timestamp
    ns : ctypes.c_char * 1024
        Namespace to place this object in... used in conjunction with id to create a unique name for the object
    id : ctypes.c_int32
        object ID useful in conjunction with the namespace for manipulating and deleting the object later
    type : ctypes.c_int32
        Type of object
    action : ctypes.c_int32
        0 add/modify an object, 1 (deprecated), 2 deletes an object, 3 deletes all objects
    pose_position : SickScanVector3Msg
        Pose of the object (positional part)
    pose_orientation : SickScanQuaternionMsg
        Pose of the object (rotational part)
    scale : SickScanVector3Msg
        Scale of the object 1,1,1 means default (usually 1 meter square)
    color : SickScanColorRGBA
        Color [0.0-1.0]
    lifetime_sec : ctypes.c_uint32
        How long the object should last before being automatically deleted.  0 means forever (seconds part)
    lifetime_nsec : ctypes.c_uint32
        How long the object should last before being automatically deleted.  0 means forever (nanoseconds part)
    frame_locked : ctypes.c_uint8
        boolean, If this marker should be frame-locked, i.e. retransformed into its frame every timestep
    points : SickScanPointArray
        Only used if the type specified has some use for them (eg. POINTS, LINE_STRIP, ...)
    colors : SickScanColorRGBAArray
        Only used if the type specified has some use for them (eg. POINTS, LINE_STRIP, ...). Number of colors must either be 0 or equal to the number of points. NOTE: alpha is not yet used
    text : ctypes.c_char * 1024
        NOTE: only used for text markers
    mesh_resource : ctypes.c_char * 1024
        NOTE: only used for MESH_RESOURCE markers
    mesh_use_embedded_materials : ctypes.c_uint8
        boolean
    """
    _fields_ = [
        ("header", SickScanHeader),                      # message timestamp
        ("ns", ctypes.c_char * 1024),                    # Namespace to place this object in... used in conjunction with id to create a unique name for the object
        ("id", ctypes.c_int32),                          # object ID useful in conjunction with the namespace for manipulating and deleting the object later
        ("type", ctypes.c_int32),                        # Type of object
        ("action", ctypes.c_int32),                      # 0 add/modify an object, 1 (deprecated), 2 deletes an object, 3 deletes all objects
        ("pose_position", SickScanVector3Msg),           # Pose of the object (positional part)
        ("pose_orientation", SickScanQuaternionMsg),     # Pose of the object (rotational part)
        ("scale", SickScanVector3Msg),                   # Scale of the object 1,1,1 means default (usually 1 meter square)
        ("color", SickScanColorRGBA),                    # Color [0.0-1.0]
        ("lifetime_sec", ctypes.c_uint32),               # How long the object should last before being automatically deleted.  0 means forever (seconds part)
        ("lifetime_nsec", ctypes.c_uint32),              # How long the object should last before being automatically deleted.  0 means forever (nanoseconds part)
        ("frame_locked", ctypes.c_uint8),                # boolean, If this marker should be frame-locked, i.e. retransformed into its frame every timestep
        ("points", SickScanPointArray),                  # Only used if the type specified has some use for them (eg. POINTS, LINE_STRIP, ...)
        ("colors", SickScanColorRGBAArray),              # Only used if the type specified has some use for them (eg. POINTS, LINE_STRIP, ...). Number of colors must either be 0 or equal to the number of points. NOTE: alpha is not yet used
        ("text", ctypes.c_char * 1024),                  # NOTE: only used for text markers
        ("mesh_resource", ctypes.c_char * 1024),         # NOTE: only used for MESH_RESOURCE markers
        ("mesh_use_embedded_materials", ctypes.c_uint8)  # boolean
    ]
 
class SickScanVisualizationMarkerBuffer(ctypes.Structure):
    """
    Array of SickScanVisualizationMarkers
 
    Attributes
    ----------
    capacity : ctypes.c_uint64
        Number of allocated elements, i.e. max. number of elements in buffer, allocated buffer size is capacity * sizeof(SickScanVisualizationMarker)
    size : ctypes.c_uint64
        Number of currently used elements in the buffer
    buffer : ctypes.POINTER(SickScanVisualizationMarker)
        Memory, data in plain order and system endianess (buffer == 0, if size == 0 && capacity == 0, otherwise allocated memory), allocation/deallocation always managed by the caller.
    """
    _fields_ = [
        ("capacity", ctypes.c_uint64),                          # Number of allocated elements, i.e. max. number of elements in buffer, allocated buffer size is capacity * sizeof(SickScanVisualizationMarker)
        ("size", ctypes.c_uint64),                              # Number of currently used elements in the buffer
        ("buffer", ctypes.POINTER(SickScanVisualizationMarker)) # Memory, data in plain order and system endianess (buffer == 0, if size == 0 && capacity == 0, otherwise allocated memory), allocation/deallocation always managed by the caller.
    ]
 
class SickScanVisualizationMarkerMsg(ctypes.Structure):
    """ 
    equivalent to visualization_msgs::MarkerArray
 
    Attributes
    ----------
    markers : SickScanVisualizationMarkerBuffer
        Array of SickScanVisualizationMarkers
    """
    _fields_ = [
        ("markers", SickScanVisualizationMarkerBuffer)          # Array of SickScanVisualizationMarkers
    ]
 
class SickScanNavReflector(ctypes.Structure):
    """ 
    NAV-350 reflector equivalent to SickScanNavReflector defined in sick_scan_api.h
    """
    _fields_ = [
        ("pos_valid", ctypes.c_uint16),
        # reflector position in [m] in ros coordinates, if pos_valid > 0:
        ("pos_x", ctypes.c_float),
        ("pos_y", ctypes.c_float),
        ("cartesian_valid", ctypes.c_uint16),
        # reflector position in [mm] in lidar coordinates, if cartesian_valid > 0:
        ("cartesian_x", ctypes.c_int32),
        ("cartesian_y", ctypes.c_int32),
        ("polar_valid", ctypes.c_uint16),
        # reflector position in [mm] and [mdeg] in polar lidar coordinates, if polar_valid > 0:
        ("polar_dist", ctypes.c_uint32),
        ("polar_phi", ctypes.c_uint32),
        ("opt_valid", ctypes.c_uint16),
        # Optional reflector data, if opt_valid > 0
        ("opt_local_id", ctypes.c_uint16),
        ("opt_global_id", ctypes.c_uint16),
        ("opt_type", ctypes.c_uint8),
        ("opt_subtype", ctypes.c_uint16),
        ("opt_quality", ctypes.c_uint16),
        ("opt_timestamp", ctypes.c_uint32), # lidar timestamp in milliseconds
        ("opt_size", ctypes.c_uint16),
        ("opt_hitcount", ctypes.c_uint16),
        ("opt_meanecho", ctypes.c_uint16),
        ("opt_startindex", ctypes.c_uint16),
        ("opt_endindex", ctypes.c_uint16),
        ("opt_timestamp_sec", ctypes.c_uint32), # timestamp converted to system time (seconds part, 0 if timestamp not valid)
        ("opt_timestamp_nsec", ctypes.c_uint32) # timestamp converted to system time (nanoseconds part, 0 if timestamp not valid)
    ]
 
class SickScanNavReflectorBuffer(ctypes.Structure):
    """ 
    Array of NAV-350 reflectors equivalent to SickScanNavReflectorBuffer defined in sick_scan_api.h
 
    Attributes
    ----------
    capacity : ctypes.c_uint64
        Number of allocated elements, i.e. max. number of elements in buffer, allocated buffer size is capacity * sizeof(SickScanNavReflector)
    size : ctypes.c_uint64
        Number of currently used elements in the buffer
    buffer : ctypes.POINTER(SickScanNavReflector)
        Memory, data in plain order and system endianess (buffer == 0, if size == 0 && capacity == 0, otherwise allocated memory), allocation/deallocation always managed by the caller.
    """
    _fields_ = [
        ("capacity", ctypes.c_uint64),                   # Number of allocated elements, i.e. max. number of elements in buffer, allocated buffer size is capacity * sizeof(SickScanVisualizationMarker)
        ("size", ctypes.c_uint64),                       # Number of currently used elements in the buffer
        ("buffer", ctypes.POINTER(SickScanNavReflector)) # Memory, data in plain order and system endianess (buffer == 0, if size == 0 && capacity == 0, otherwise allocated memory), allocation/deallocation always managed by the caller.
    ]
 
class SickScanNavPoseLandmarkMsg(ctypes.Structure):
    """ 
    NAV-350 pose and landmark message equivalent to SickScanNavPoseLandmarkMsg defined in sick_scan_api.h
    """
    _fields_ = [
        ("pose_valid", ctypes.c_uint16),
        # NAV pose, if pose_valid > 0:
        ("pose_x", ctypes.c_float),   # x-position in ros coordinates in m
        ("pose_y", ctypes.c_float),   # y-position in ros coordinates in m
        ("pose_yaw", ctypes.c_float), # yaw angle in ros coordinates in radians
        ("pose_timestamp_sec", ctypes.c_uint32), # timestamp of pose converted to system time (seconds part, 0 if timestamp not valid)
        ("pose_timestamp_nsec", ctypes.c_uint32), # timestamp of pose converted to system time (nanoseconds part, 0 if timestamp not valid)
        ("pose_nav_x", ctypes.c_int32), # x-position in lidar coordinates in mm
        ("pose_nav_y", ctypes.c_int32), # y-position in lidar coordinates in mm
        ("pose_nav_phi", ctypes.c_uint32), # orientation in lidar coordinates in 0 ... 360000 mdeg
        ("pose_opt_valid", ctypes.c_uint16),
        # Optional NAV pose data, if pose_opt_valid > 0:
        ("pose_opt_output_mode", ctypes.c_uint8),
        ("pose_opt_timestamp", ctypes.c_uint32), # lidar timestamp in milliseconds
        ("pose_opt_mean_dev", ctypes.c_int32),
        ("pose_opt_nav_mode", ctypes.c_uint8),
        ("pose_opt_info_state", ctypes.c_uint32),
        ("pose_opt_quant_used_reflectors", ctypes.c_uint8),
        # NAV reflectors:
        ("reflectors", SickScanNavReflectorBuffer) # Array of SickScanNavReflectors
    ]
 
class SickScanNavOdomVelocityMsg(ctypes.Structure):
    """ 
    NAV-350 velocity/odometry data in nav coordinates, see NAVOdomVelocity.msg
    """
    _fields_ = [
        ("vel_x", ctypes.c_float),      # x-component of velocity in the coordinate system defined by coordbase (i.e. in lidar coordinate for coordbase=0) in m/s, -32.0 ... +32.0 m/s
        ("vel_y", ctypes.c_float),      # y-component of velocity in the coordinate system defined by coordbase (i.e. in lidar coordinate for coordbase=0) in m/s, -32.0 ... +32.0 m/s
        ("omega", ctypes.c_float),      # angular velocity of the NAV350 in radians/s, -2*PI ... +2*PI rad/s
        ("timestamp", ctypes.c_uint32), # timestamp of the Velocity vector related to the NAV350 clock
        ("coordbase", ctypes.c_uint8)   # coordinate system of the velocity vector (local or global), 0 = local coordinate system of the NAV350, 1 = absolute coordinate system
    ]
 
class SickScanOdomVelocityMsg(ctypes.Structure):
    """ 
    Velocity/odometry data in ros coordinates
    """
    _fields_ = [
        ("vel_x", ctypes.c_float),          # x-component of velocity in ros coordinates in m/s
        ("vel_y", ctypes.c_float),          # y-component of velocity in ros coordinates in m/s
        ("omega", ctypes.c_float),          # angular velocity in radians/s
        ("timestamp_sec", ctypes.c_uint32), # seconds part of system timestamp of the odometry data
        ("timestamp_nsec", ctypes.c_uint32) # nanoseconds part of system timestamp of the odometry data
    ]
 
class SickScanLogMsg(ctypes.Structure):
    """ 
    general log message
    """
    _fields_ = [
        ("log_level", ctypes.c_int32),      # log_level defined in ros::console::levels: Info=1, Warn=2, Error=3, Fatal=4
        ("log_message", ctypes.c_char_p)    # log message
    ]
 
class SickScanDiagnosticMsg(ctypes.Structure):
    """ 
    general log message
    """
    _fields_ = [
        ("status_code", ctypes.c_int32),    # status_code defined in SICK_DIAGNOSTIC_STATUS: OK=0 (normal operation), WARN=1 (warning), ERROR=2 (error, should not occure), INIT=3 (initialization after startup or reconnection), EXIT=4 (sick_scan_xd exiting)
        ("status_message", ctypes.c_char_p) # diagnostic message
    ]
 
class SickScanApiErrorCodes(Enum): # 
    """ 
    Error codes, return values of SickScanApi-functions
 
    Attributes
    ----------
    SICK_SCAN_API_SUCCESS = 0, "SICK_SCAN_API_SUCCESS"                 # function executed successfully
    SICK_SCAN_API_ERROR = 1, "SICK_SCAN_API_ERROR"                     # general (unspecified) error
    SICK_SCAN_API_NOT_LOADED = 2, "SICK_SCAN_API_NOT_LOADED"           # sick_scan_xd library not loaded
    SICK_SCAN_API_NOT_INITIALIZED = 3, "SICK_SCAN_API_NOT_INITIALIZED" # API not initialized
    SICK_SCAN_API_NOT_IMPLEMENTED = 4, "SICK_SCAN_API_NOT_IMPLEMENTED" # function not implemented in sick_scan_xd library
    SICK_SCAN_API_TIMEOUT = 5, "SICK_SCAN_API_TIMEOUT"                 # timeout during wait for response
    """
    SICK_SCAN_API_SUCCESS = 0, "SICK_SCAN_API_SUCCESS"                 # function executed successfully
    SICK_SCAN_API_ERROR = 1, "SICK_SCAN_API_ERROR"                     # general (unspecified) error
    SICK_SCAN_API_NOT_LOADED = 2, "SICK_SCAN_API_NOT_LOADED"           # sick_scan_xd library not loaded
    SICK_SCAN_API_NOT_INITIALIZED = 3, "SICK_SCAN_API_NOT_INITIALIZED" # API not initialized
    SICK_SCAN_API_NOT_IMPLEMENTED = 4, "SICK_SCAN_API_NOT_IMPLEMENTED" # function not implemented in sick_scan_xd library
    SICK_SCAN_API_TIMEOUT = 5, "SICK_SCAN_API_TIMEOUT"                 # timeout during wait for response
    def __int__(self):
        return self.value[0]
    def __str__(self):
        return self.value[1]
 
""" 
Callback declarations
"""
 
SickScanPointCloudMsgCallback = ctypes.CFUNCTYPE(None, ctypes.c_void_p, ctypes.POINTER(SickScanPointCloudMsg))                 # sick_scan_api.h: typedef void(* SickScanPointCloudMsgCallback)(SickScanApiHandle apiHandle, const SickScanPointCloudMsg* msg);
SickScanImuMsgCallback = ctypes.CFUNCTYPE(None, ctypes.c_void_p, ctypes.POINTER(SickScanImuMsg))                               # sick_scan_api.h: typedef void(* SickScanImuMsgCallback)(SickScanApiHandle apiHandle, const SickScanImuMsg* msg);
SickScanLFErecMsgCallback = ctypes.CFUNCTYPE(None, ctypes.c_void_p, ctypes.POINTER(SickScanLFErecMsg))                         # sick_scan_api.h: typedef void(* SickScanLFErecMsgCallback)(SickScanApiHandle apiHandle, const SickScanLFErecMsg* msg);
SickScanLIDoutputstateMsgCallback = ctypes.CFUNCTYPE(None, ctypes.c_void_p, ctypes.POINTER(SickScanLIDoutputstateMsg))         # sick_scan_api.h: typedef void(* SickScanLIDoutputstateMsgCallback)(SickScanApiHandle apiHandle, const SickScanLIDoutputstateMsg* msg);
SickScanRadarScanCallback = ctypes.CFUNCTYPE(None, ctypes.c_void_p, ctypes.POINTER(SickScanRadarScan))                         # sick_scan_api.h: typedef void(* SickScanRadarScanCallback)(SickScanApiHandle apiHandle, const SickScanRadarScan* msg);
SickScanLdmrsObjectArrayCallback = ctypes.CFUNCTYPE(None, ctypes.c_void_p, ctypes.POINTER(SickScanLdmrsObjectArray))           # sick_scan_api.h: typedef void(* SickScanLdmrsObjectArrayCallback)(SickScanApiHandle apiHandle, const SickScanLdmrsObjectArray* msg);
SickScanVisualizationMarkerCallback = ctypes.CFUNCTYPE(None, ctypes.c_void_p, ctypes.POINTER(SickScanVisualizationMarkerMsg))  # sick_scan_api.h: typedef void(* SickScanVisualizationMarkerCallback)(SickScanApiHandle apiHandle, const SickScanVisualizationMarkerMsg* msg);
SickScanNavPoseLandmarkCallback = ctypes.CFUNCTYPE(None, ctypes.c_void_p, ctypes.POINTER(SickScanNavPoseLandmarkMsg))          # sick_scan_api.h: typedef void(* SickScanNavPoseLandmarkCallback)(SickScanApiHandle apiHandle, const SickScanNavPoseLandmarkMsg* msg);
SickScanLogMsgCallback = ctypes.CFUNCTYPE(None, ctypes.c_void_p, ctypes.POINTER(SickScanLogMsg))                               # sick_scan_api.h: typedef void(* SickScanLogMsgCallback)(SickScanApiHandle apiHandle, const SickScanLogMsg* msg);
SickScanDiagnosticMsgCallback = ctypes.CFUNCTYPE(None, ctypes.c_void_p, ctypes.POINTER(SickScanDiagnosticMsg))                 # sick_scan_api.h: typedef void(* SickScanDiagnosticMsgCallback)(SickScanApiHandle apiHandle, const SickScanDiagnosticMsg* msg); 
 
 
""" 
Functions to initialize and close the API and a lidar
""" 
 
def ctypesCharArrayToString(char_array):
    """ 
    Returns a python string from a zero terminated ctypes char array
    """ 
    return ''.join([chr(i) for i in char_array]).rstrip('\x00')
 
def loadLibrary(paths, lib_filname):
    """ 
    loads and returns a library, given its filename and a list of folder 
    """ 
    for path in paths:
        filename = path + lib_filname
        if os.path.exists(filename):
            return ctypes.CDLL(filename)
    return ctypes.CDLL(lib_filname)
 
def SickScanApiLoadLibrary(paths, lib_filname):
    """ 
    Load sick_scan_library and functions
    """ 
    sick_scan_library = loadLibrary(paths, lib_filname)
    # sick_scan_api.h: SickScanApiHandle SickScanApiCreate(int argc, char** argv);
    sick_scan_library.SickScanApiCreate.argtypes = [ctypes.c_int, ctypes.POINTER(ctypes.c_char_p)]
    sick_scan_library.SickScanApiCreate.restype = ctypes.c_void_p
    # sick_scan_api.h: int32_t SickScanApiRelease(SickScanApiHandle apiHandle);
    sick_scan_library.SickScanApiRelease.argtypes = [ctypes.c_void_p]
    sick_scan_library.SickScanApiRelease.restype = ctypes.c_int
    # sick_scan_api.h: int32_t SickScanApiInitByLaunchfile(SickScanApiHandle apiHandle, const char* launchfile_args);
    sick_scan_library.SickScanApiInitByLaunchfile.argtypes = [ctypes.c_void_p, ctypes.c_char_p]
    sick_scan_library.SickScanApiInitByLaunchfile.restype = ctypes.c_int
    # sick_scan_api.h: int32_t SickScanApiInitByCli(SickScanApiHandle apiHandle, int argc, char** argv);
    sick_scan_library.SickScanApiInitByCli.argtypes = [ctypes.c_void_p, ctypes.c_int, ctypes.POINTER(ctypes.c_char_p)]
    sick_scan_library.SickScanApiInitByCli.restype = ctypes.c_int
    # sick_scan_api.h: int32_t SickScanApiClose(SickScanApiHandle apiHandle);
    sick_scan_library.SickScanApiClose.argtypes = [ctypes.c_void_p]
    sick_scan_library.SickScanApiClose.restype = ctypes.c_int
    # sick_scan_api.h: int32_t SickScanApiRegisterPolarPointCloudMsg(SickScanApiHandle apiHandle, SickScanPointCloudMsgCallback callback);
    sick_scan_library.SickScanApiRegisterCartesianPointCloudMsg.argtypes = [ctypes.c_void_p, SickScanPointCloudMsgCallback]
    sick_scan_library.SickScanApiRegisterCartesianPointCloudMsg.restype = ctypes.c_int
    # sick_scan_api.h: int32_t SickScanApiDeregisterCartesianPointCloudMsg(SickScanApiHandle apiHandle, SickScanPointCloudMsgCallback callback);
    sick_scan_library.SickScanApiDeregisterCartesianPointCloudMsg.argtypes = [ctypes.c_void_p, SickScanPointCloudMsgCallback]
    sick_scan_library.SickScanApiDeregisterCartesianPointCloudMsg.restype = ctypes.c_int
    # sick_scan_api.h: int32_t SickScanApiRegisterPolarPointCloudMsg(SickScanApiHandle apiHandle, SickScanPointCloudMsgCallback callback);
    sick_scan_library.SickScanApiRegisterPolarPointCloudMsg.argtypes = [ctypes.c_void_p, SickScanPointCloudMsgCallback]
    sick_scan_library.SickScanApiRegisterPolarPointCloudMsg.restype = ctypes.c_int
    # sick_scan_api.h: int32_t SickScanApiDeregisterPolarPointCloudMsg(SickScanApiHandle apiHandle, SickScanPointCloudMsgCallback callback);
    sick_scan_library.SickScanApiDeregisterPolarPointCloudMsg.argtypes = [ctypes.c_void_p, SickScanPointCloudMsgCallback]
    sick_scan_library.SickScanApiDeregisterPolarPointCloudMsg.restype = ctypes.c_int
    # sick_scan_api.h: int32_t SickScanApiRegisterImuMsg(SickScanApiHandle apiHandle, SickScanImuMsgCallback callback);
    sick_scan_library.SickScanApiRegisterImuMsg.argtypes = [ctypes.c_void_p, SickScanImuMsgCallback]
    sick_scan_library.SickScanApiRegisterImuMsg.restype = ctypes.c_int
    # sick_scan_api.h: int32_t SickScanApiDeregisterImuMsg(SickScanApiHandle apiHandle, SickScanImuMsgCallback callback);
    sick_scan_library.SickScanApiDeregisterImuMsg.argtypes = [ctypes.c_void_p, SickScanImuMsgCallback]
    sick_scan_library.SickScanApiDeregisterImuMsg.restype = ctypes.c_int
    # sick_scan_api.h: int32_t SickScanApiRegisterLFErecMsg(SickScanApiHandle apiHandle, SickScanLFErecMsgCallback callback);
    sick_scan_library.SickScanApiRegisterLFErecMsg.argtypes = [ctypes.c_void_p, SickScanLFErecMsgCallback]
    sick_scan_library.SickScanApiRegisterLFErecMsg.restype = ctypes.c_int
    # sick_scan_api.h: int32_t SickScanApiDeregisterLFErecMsg(SickScanApiHandle apiHandle, SickScanLFErecMsgCallback callback);
    sick_scan_library.SickScanApiDeregisterLFErecMsg.argtypes = [ctypes.c_void_p, SickScanLFErecMsgCallback]
    sick_scan_library.SickScanApiDeregisterLFErecMsg.restype = ctypes.c_int
    # sick_scan_api.h: int32_t SickScanApiRegisterLIDoutputstateMsg(SickScanApiHandle apiHandle, SickScanLIDoutputstateMsgCallback callback);
    sick_scan_library.SickScanApiRegisterLIDoutputstateMsg.argtypes = [ctypes.c_void_p, SickScanLIDoutputstateMsgCallback]
    sick_scan_library.SickScanApiRegisterLIDoutputstateMsg.restype = ctypes.c_int
    # sick_scan_api.h: int32_t SickScanApiDeregisterLIDoutputstateMsg(SickScanApiHandle apiHandle, SickScanLIDoutputstateMsgCallback callback);
    sick_scan_library.SickScanApiDeregisterLIDoutputstateMsg.argtypes = [ctypes.c_void_p, SickScanLIDoutputstateMsgCallback]
    sick_scan_library.SickScanApiDeregisterLIDoutputstateMsg.restype = ctypes.c_int
    # sick_scan_api.h: int32_t SickScanApiRegisterRadarScanMsg(SickScanApiHandle apiHandle, SickScanRadarScanCallback callback);
    sick_scan_library.SickScanApiRegisterRadarScanMsg.argtypes = [ctypes.c_void_p, SickScanRadarScanCallback]
    sick_scan_library.SickScanApiRegisterRadarScanMsg.restype = ctypes.c_int
    # sick_scan_api.h: int32_t SickScanApiDeregisterRadarScanMsg(SickScanApiHandle apiHandle, SickScanRadarScanCallback callback);
    sick_scan_library.SickScanApiDeregisterRadarScanMsg.argtypes = [ctypes.c_void_p, SickScanRadarScanCallback]
    sick_scan_library.SickScanApiDeregisterRadarScanMsg.restype = ctypes.c_int
    # sick_scan_api.h: int32_t SickScanApiRegisterLdmrsObjectArrayMsg(SickScanApiHandle apiHandle, SickScanLdmrsObjectArrayCallback callback);
    sick_scan_library.SickScanApiRegisterLdmrsObjectArrayMsg.argtypes = [ctypes.c_void_p, SickScanLdmrsObjectArrayCallback]
    sick_scan_library.SickScanApiRegisterLdmrsObjectArrayMsg.restype = ctypes.c_int
    # sick_scan_api.h: int32_t SickScanApiDeregisterLdmrsObjectArrayMsg(SickScanApiHandle apiHandle, SickScanLdmrsObjectArrayCallback callback);
    sick_scan_library.SickScanApiDeregisterLdmrsObjectArrayMsg.argtypes = [ctypes.c_void_p, SickScanLdmrsObjectArrayCallback]
    sick_scan_library.SickScanApiDeregisterLdmrsObjectArrayMsg.restype = ctypes.c_int
    # sick_scan_api.h: int32_t SickScanApiRegisterVisualizationMarkerMsg(SickScanApiHandle apiHandle, SickScanVisualizationMarkerCallback callback);
    sick_scan_library.SickScanApiRegisterVisualizationMarkerMsg.argtypes = [ctypes.c_void_p, SickScanVisualizationMarkerCallback]
    sick_scan_library.SickScanApiRegisterVisualizationMarkerMsg.restype = ctypes.c_int
    # sick_scan_api.h: int32_t SickScanApiDeregisterVisualizationMarkerMsg(SickScanApiHandle apiHandle, SickScanVisualizationMarkerCallback callback);
    sick_scan_library.SickScanApiDeregisterVisualizationMarkerMsg.argtypes = [ctypes.c_void_p, SickScanVisualizationMarkerCallback]
    sick_scan_library.SickScanApiDeregisterVisualizationMarkerMsg.restype = ctypes.c_int
    # sick_scan_api.h:  int32_t SickScanApiRegisterDiagnosticMsg(SickScanApiHandle apiHandle, SickScanDiagnosticMsgCallback callback);
    sick_scan_library.SickScanApiRegisterDiagnosticMsg.argtypes = [ctypes.c_void_p, SickScanDiagnosticMsgCallback]
    sick_scan_library.SickScanApiRegisterDiagnosticMsg.restype = ctypes.c_int
    # sick_scan_api.h:  int32_t SickScanApiDeregisterDiagnosticMsg(SickScanApiHandle apiHandle, SickScanDiagnosticMsgCallback callback);
    sick_scan_library.SickScanApiDeregisterDiagnosticMsg.argtypes = [ctypes.c_void_p, SickScanDiagnosticMsgCallback]
    sick_scan_library.SickScanApiDeregisterDiagnosticMsg.restype = ctypes.c_int
    # sick_scan_api.h:  int32_t SickScanApiRegisterLogMsg(SickScanApiHandle apiHandle, SickScanLogMsgCallback callback);
    sick_scan_library.SickScanApiRegisterLogMsg.argtypes = [ctypes.c_void_p, SickScanLogMsgCallback]
    sick_scan_library.SickScanApiRegisterLogMsg.restype = ctypes.c_int
    # sick_scan_api.h:  int32_t SickScanApiDeregisterLogMsg(SickScanApiHandle apiHandle, SickScanLogMsgCallback callback);
    sick_scan_library.SickScanApiDeregisterLogMsg.argtypes = [ctypes.c_void_p, SickScanLogMsgCallback]
    sick_scan_library.SickScanApiDeregisterLogMsg.restype = ctypes.c_int
    # sick_scan_api.h:  int32_t SickScanApiGetStatus(SickScanApiHandle apiHandle, int32_t* status_code, char* message_buffer, int32_t message_buffer_size);
    sick_scan_library.SickScanApiGetStatus.argtypes = [ctypes.c_void_p, ctypes.POINTER(ctypes.c_int32), ctypes.c_char_p, ctypes.c_int32]
    sick_scan_library.SickScanApiGetStatus.restype = ctypes.c_int
    # sick_scan_api.h:  int32_t SickScanApiSendSOPAS(SickScanApiHandle apiHandle, const char* sopas_command, char* sopas_response_buffer, int32_t response_buffer_size);
    sick_scan_library.SickScanApiSendSOPAS.argtypes = [ctypes.c_void_p, ctypes.c_char_p, ctypes.c_char_p, ctypes.c_int32]
    sick_scan_library.SickScanApiSendSOPAS.restype = ctypes.c_int
    # sick_scan_api.h:  int32_t SickScanApiSetVerboseLevel(SickScanApiHandle apiHandle, int32_t verbose_level);
    sick_scan_library.SickScanApiSetVerboseLevel.argtypes = [ctypes.c_void_p, ctypes.c_int32]
    sick_scan_library.SickScanApiSetVerboseLevel.restype = ctypes.c_int
    # sick_scan_api.h:  int32_t SickScanApiGetVerboseLevel(SickScanApiHandle apiHandle);
    sick_scan_library.SickScanApiGetVerboseLevel.argtypes = [ctypes.c_void_p]
    sick_scan_library.SickScanApiGetVerboseLevel.restype = ctypes.c_int
    # sick_scan_api.h: int32_t SickScanApiWaitNextCartesianPointCloudMsg(SickScanApiHandle apiHandle, SickScanPointCloudMsg* msg, double timeout_sec);
    sick_scan_library.SickScanApiWaitNextCartesianPointCloudMsg.argtypes = [ctypes.c_void_p, ctypes.POINTER(SickScanPointCloudMsg), ctypes.c_double]
    sick_scan_library.SickScanApiWaitNextCartesianPointCloudMsg.restype = ctypes.c_int
    # sick_scan_api.h: int32_t SickScanApiWaitNextPolarPointCloudMsg(SickScanApiHandle apiHandle, SickScanPointCloudMsg* msg, double timeout_sec);
    sick_scan_library.SickScanApiWaitNextPolarPointCloudMsg.argtypes = [ctypes.c_void_p, ctypes.POINTER(SickScanPointCloudMsg), ctypes.c_double]
    sick_scan_library.SickScanApiWaitNextPolarPointCloudMsg.restype = ctypes.c_int
    # sick_scan_api.h: int32_t SickScanApiFreePointCloudMsg(SickScanApiHandle apiHandle, SickScanPointCloudMsg* msg);
    sick_scan_library.SickScanApiFreePointCloudMsg.argtypes = [ctypes.c_void_p, ctypes.POINTER(SickScanPointCloudMsg)]
    sick_scan_library.SickScanApiFreePointCloudMsg.restype = ctypes.c_int
    # sick_scan_api.h: int32_t SickScanApiWaitNextImuMsg(SickScanApiHandle apiHandle, SickScanImuMsg* msg, double timeout_sec);
    sick_scan_library.SickScanApiWaitNextImuMsg.argtypes = [ctypes.c_void_p, ctypes.POINTER(SickScanImuMsg), ctypes.c_double]
    sick_scan_library.SickScanApiWaitNextImuMsg.restype = ctypes.c_int
    # sick_scan_api.h: int32_t SickScanApiFreeImuMsg(SickScanApiHandle apiHandle, SickScanImuMsg* msg)
    sick_scan_library.SickScanApiFreeImuMsg.argtypes = [ctypes.c_void_p, ctypes.POINTER(SickScanImuMsg)]
    sick_scan_library.SickScanApiFreeImuMsg.restype = ctypes.c_int
    # sick_scan_api.h: int32_t SickScanApiWaitNextLFErecMsg(SickScanApiHandle apiHandle, SickScanLFErecMsg* msg, double timeout_sec);
    sick_scan_library.SickScanApiWaitNextLFErecMsg.argtypes = [ctypes.c_void_p, ctypes.POINTER(SickScanLFErecMsg), ctypes.c_double]
    sick_scan_library.SickScanApiWaitNextLFErecMsg.restype = ctypes.c_int
    # sick_scan_api.h: int32_t SickScanApiFreeLFErecMsg(SickScanApiHandle apiHandle, SickScanLFErecMsg* msg);
    sick_scan_library.SickScanApiFreeLFErecMsg.argtypes = [ctypes.c_void_p, ctypes.POINTER(SickScanLFErecMsg)]
    sick_scan_library.SickScanApiFreeLFErecMsg.restype = ctypes.c_int
    # sick_scan_api.h: int32_t SickScanApiWaitNextLIDoutputstateMsg(SickScanApiHandle apiHandle, SickScanLIDoutputstateMsg* msg, double timeout_sec);
    sick_scan_library.SickScanApiWaitNextLIDoutputstateMsg.argtypes = [ctypes.c_void_p, ctypes.POINTER(SickScanLIDoutputstateMsg), ctypes.c_double]
    sick_scan_library.SickScanApiWaitNextLIDoutputstateMsg.restype = ctypes.c_int
    # sick_scan_api.h: int32_t SickScanApiFreeLIDoutputstateMsg(SickScanApiHandle apiHandle, SickScanLIDoutputstateMsg* msg);
    sick_scan_library.SickScanApiFreeLIDoutputstateMsg.argtypes = [ctypes.c_void_p, ctypes.POINTER(SickScanLIDoutputstateMsg)]
    sick_scan_library.SickScanApiFreeLIDoutputstateMsg.restype = ctypes.c_int
    # sick_scan_api.h: int32_t SickScanApiWaitNextRadarScanMsg(SickScanApiHandle apiHandle, SickScanRadarScan* msg, double timeout_sec);
    sick_scan_library.SickScanApiWaitNextRadarScanMsg.argtypes = [ctypes.c_void_p, ctypes.POINTER(SickScanRadarScan), ctypes.c_double]
    sick_scan_library.SickScanApiWaitNextRadarScanMsg.restype = ctypes.c_int
    # sick_scan_api.h: int32_t SickScanApiFreeRadarScanMsg(SickScanApiHandle apiHandle, SickScanRadarScan* msg);
    sick_scan_library.SickScanApiFreeRadarScanMsg.argtypes = [ctypes.c_void_p, ctypes.POINTER(SickScanRadarScan)]
    sick_scan_library.SickScanApiFreeRadarScanMsg.restype = ctypes.c_int
    # sick_scan_api.h: int32_t SickScanApiWaitNextLdmrsObjectArrayMsg(SickScanApiHandle apiHandle, SickScanLdmrsObjectArray* msg, double timeout_sec);
    sick_scan_library.SickScanApiWaitNextLdmrsObjectArrayMsg.argtypes = [ctypes.c_void_p, ctypes.POINTER(SickScanLdmrsObjectArray), ctypes.c_double]
    sick_scan_library.SickScanApiWaitNextLdmrsObjectArrayMsg.restype = ctypes.c_int
    # sick_scan_api.h: int32_t SickScanApiFreeLdmrsObjectArrayMsg(SickScanApiHandle apiHandle, SickScanLdmrsObjectArray* msg);
    sick_scan_library.SickScanApiFreeLdmrsObjectArrayMsg.argtypes = [ctypes.c_void_p, ctypes.POINTER(SickScanLdmrsObjectArray)]
    sick_scan_library.SickScanApiFreeLdmrsObjectArrayMsg.restype = ctypes.c_int
    # sick_scan_api.h: int32_t SickScanApiWaitNextVisualizationMarkerMsg(SickScanApiHandle apiHandle, SickScanVisualizationMarkerMsg* msg, double timeout_sec);
    sick_scan_library.SickScanApiWaitNextVisualizationMarkerMsg.argtypes = [ctypes.c_void_p, ctypes.POINTER(SickScanVisualizationMarkerMsg), ctypes.c_double]
    sick_scan_library.SickScanApiWaitNextVisualizationMarkerMsg.restype = ctypes.c_int
    # sick_scan_api.h: int32_t SickScanApiFreeVisualizationMarkerMsg(SickScanApiHandle apiHandle, SickScanVisualizationMarkerMsg* msg);
    sick_scan_library.SickScanApiFreeVisualizationMarkerMsg.argtypes = [ctypes.c_void_p, ctypes.POINTER(SickScanVisualizationMarkerMsg)]
    sick_scan_library.SickScanApiFreeVisualizationMarkerMsg.restype = ctypes.c_int
    # sick_scan_api.h: int32_t SickScanApiRegisterNavPoseLandmarkMsg(SickScanApiHandle apiHandle, SickScanNavPoseLandmarkCallback callback);
    sick_scan_library.SickScanApiRegisterNavPoseLandmarkMsg.argtypes = [ctypes.c_void_p, SickScanNavPoseLandmarkCallback]
    sick_scan_library.SickScanApiRegisterNavPoseLandmarkMsg.restype = ctypes.c_int
    # sick_scan_api.h: int32_t SickScanApiDeregisterNavPoseLandmarkMsg(SickScanApiHandle apiHandle, SickScanNavPoseLandmarkCallback callback);
    sick_scan_library.SickScanApiDeregisterNavPoseLandmarkMsg.argtypes = [ctypes.c_void_p, SickScanNavPoseLandmarkCallback]
    sick_scan_library.SickScanApiDeregisterNavPoseLandmarkMsg.restype = ctypes.c_int
    # sick_scan_api.h: int32_t SickScanApiWaitNextNavPoseLandmarkMsg(SickScanApiHandle apiHandle, SickScanNavPoseLandmarkMsg* msg, double timeout_sec);
    sick_scan_library.SickScanApiWaitNextNavPoseLandmarkMsg.argtypes = [ctypes.c_void_p, ctypes.POINTER(SickScanNavPoseLandmarkMsg), ctypes.c_double]
    sick_scan_library.SickScanApiWaitNextNavPoseLandmarkMsg.restype = ctypes.c_int
    # sick_scan_api.h: int32_t SickScanApiFreeNavPoseLandmarkMsg(SickScanApiHandle apiHandle, SickScanNavPoseLandmarkMsg* msg);
    sick_scan_library.SickScanApiFreeNavPoseLandmarkMsg.argtypes = [ctypes.c_void_p, ctypes.POINTER(SickScanNavPoseLandmarkMsg)]
    sick_scan_library.SickScanApiFreeNavPoseLandmarkMsg.restype = ctypes.c_int
    # sick_scan_api.h: int32_t SickScanApiNavOdomVelocityMsg(SickScanApiHandle apiHandle, SickScanNavOdomVelocityMsg* msg);
    sick_scan_library.SickScanApiNavOdomVelocityMsg.argtypes = [ctypes.c_void_p, ctypes.POINTER(SickScanNavOdomVelocityMsg)]
    sick_scan_library.SickScanApiNavOdomVelocityMsg.restype = ctypes.c_int
    # sick_scan_api.h: int32_t SickScanApiOdomVelocityMsg(SickScanApiHandle apiHandle, SickScanOdomVelocityMsg* msg);
    sick_scan_library.SickScanApiOdomVelocityMsg.argtypes = [ctypes.c_void_p, ctypes.POINTER(SickScanOdomVelocityMsg)]
    sick_scan_library.SickScanApiOdomVelocityMsg.restype = ctypes.c_int
    return sick_scan_library
 
def SickScanApiUnloadLibrary(sick_scan_library):
    """ 
    Unload sick_scan_xd api library
    """ 
    del sick_scan_library
 
def SickScanApiCreate(sick_scan_library):
    """ 
    Create an instance of sick_scan_xd api.
    Call SickScanApiInitByLaunchfile or SickScanApiInitByCli to process a lidar.
    """ 
    null_ptr = ctypes.POINTER(ctypes.c_char_p)()
    api_handle = sick_scan_library.SickScanApiCreate(0, null_ptr)
    return api_handle
 
def SickScanApiRelease(sick_scan_library, api_handle):
    """ 
    Release and free all resources of the api handle; the handle is invalid after SickScanApiRelease
    """ 
    return sick_scan_library.SickScanApiRelease(api_handle)
 
def SickScanApiInitByLaunchfile(sick_scan_library, api_handle, launchfile_args):
    """ 
    Initialize a lidar by launchfile and start message receiving and processing
    """ 
    return sick_scan_library.SickScanApiInitByLaunchfile(api_handle, ctypes.create_string_buffer(str.encode(launchfile_args)))
 
def SickScanApiClose(sick_scan_library, api_handle):
    """ 
    Release and free all resources of the api handle; the handle is invalid after SickScanApiRelease
    """ 
    return sick_scan_library.SickScanApiClose(api_handle)
 
""" 
Registration and deregistration of message callbacks
""" 
 
def SickScanApiRegisterCartesianPointCloudMsg(sick_scan_library, api_handle, pointcloud_callback):
    """ 
    Register a callback for cartesian PointCloud messages, pointcloud in cartesian coordinates with fields x, y, z, intensity
    """ 
    return sick_scan_library.SickScanApiRegisterCartesianPointCloudMsg(api_handle, pointcloud_callback)
 
def SickScanApiDeregisterCartesianPointCloudMsg(sick_scan_library, api_handle, pointcloud_callback):
    """ 
    Deregister a callback for cartesian PointCloud messages, pointcloud in cartesian coordinates with fields x, y, z, intensity
    """ 
    return sick_scan_library.SickScanApiDeregisterCartesianPointCloudMsg(api_handle, pointcloud_callback)
 
def SickScanApiRegisterPolarPointCloudMsg(sick_scan_library, api_handle, pointcloud_callback):
    """ 
    Register a callback for polar PointCloud messages, pointcloud in polar coordinates with fields range, azimuth, elevation, intensity
    """ 
    return sick_scan_library.SickScanApiRegisterPolarPointCloudMsg(api_handle, pointcloud_callback)
 
def SickScanApiDeregisterPolarPointCloudMsg(sick_scan_library, api_handle, pointcloud_callback):
    """ 
    Deregister a callback for polar PointCloud messages, pointcloud in polar coordinates with fields range, azimuth, elevation, intensity
    """ 
    return sick_scan_library.SickScanApiDeregisterPolarPointCloudMsg(api_handle, pointcloud_callback)
 
def SickScanApiRegisterImuMsg(sick_scan_library, api_handle, imu_callback):
    """ 
    Register a callback for Imu messages
    """ 
    return sick_scan_library.SickScanApiRegisterImuMsg(api_handle, imu_callback)
 
def SickScanApiDeregisterImuMsg(sick_scan_library, api_handle, imu_callback):
    """ 
    Deregister a callback for Imu messages
    """ 
    return sick_scan_library.SickScanApiDeregisterImuMsg(api_handle, imu_callback)
 
def SickScanApiRegisterLFErecMsg(sick_scan_library, api_handle, lferec_callback):
    """ 
    Register a callback for LFErec messages
    """ 
    return sick_scan_library.SickScanApiRegisterLFErecMsg(api_handle, lferec_callback)
 
def SickScanApiDeregisterLFErecMsg(sick_scan_library, api_handle, lferec_callback):
    """ 
    Deregister a callback for LFErec messages
    """ 
    return sick_scan_library.SickScanApiDeregisterLFErecMsg(api_handle, lferec_callback)
 
def SickScanApiRegisterLIDoutputstateMsg(sick_scan_library, api_handle, lidoutputstate_callback):
    """ 
    Register a callback for LIDoutputstate messages
    """ 
    return sick_scan_library.SickScanApiRegisterLIDoutputstateMsg(api_handle, lidoutputstate_callback)
 
def SickScanApiDeregisterLIDoutputstateMsg(sick_scan_library, api_handle, lidoutputstate_callback):
    """ 
    Deregister a callback for LIDoutputstate messages
    """ 
    return sick_scan_library.SickScanApiDeregisterLIDoutputstateMsg(api_handle, lidoutputstate_callback)
 
def SickScanApiRegisterRadarScanMsg(sick_scan_library, api_handle, radarscan_callback):
    """ 
    Register a callback for RadarScan messages
    """ 
    return sick_scan_library.SickScanApiRegisterRadarScanMsg(api_handle, radarscan_callback)
 
def SickScanApiDeregisterRadarScanMsg(sick_scan_library, api_handle, radarscan_callback):
    """ 
    Deregister a callback for RadarScan messages
    """ 
    return sick_scan_library.SickScanApiDeregisterRadarScanMsg(api_handle, radarscan_callback)
 
def SickScanApiRegisterLdmrsObjectArrayMsg(sick_scan_library, api_handle, ldmrsobjectarray_callback):
    """ 
    Register a callback for LdmrsObjectArray messages
    """ 
    return sick_scan_library.SickScanApiRegisterLdmrsObjectArrayMsg(api_handle, ldmrsobjectarray_callback)
 
def SickScanApiDeregisterLdmrsObjectArrayMsg(sick_scan_library, api_handle, ldmrsobjectarray_callback):
    """ 
    Deregister a callback for LdmrsObjectArray messages
    """ 
    return sick_scan_library.SickScanApiDeregisterLdmrsObjectArrayMsg(api_handle, ldmrsobjectarray_callback)
 
def SickScanApiRegisterVisualizationMarkerMsg(sick_scan_library, api_handle, ldmrsobjectarray_callback):
    """ 
    Register a callback for VisualizationMarker messages
    """ 
    return sick_scan_library.SickScanApiRegisterVisualizationMarkerMsg(api_handle, ldmrsobjectarray_callback)
 
def SickScanApiDeregisterVisualizationMarkerMsg(sick_scan_library, api_handle, ldmrsobjectarray_callback):
    """ 
    Deregister a callback for VisualizationMarker messages
    """ 
    return sick_scan_library.SickScanApiDeregisterVisualizationMarkerMsg(api_handle, ldmrsobjectarray_callback)
 
def SickScanApiRegisterNavPoseLandmarkMsg(sick_scan_library, api_handle, callback):
    """ 
    Register a callback for SickScanNavPoseLandmarkMsg messages
    """ 
    return sick_scan_library.SickScanApiRegisterNavPoseLandmarkMsg(api_handle, callback)
 
def SickScanApiDeregisterNavPoseLandmarkMsg(sick_scan_library, api_handle, callback):
    """ 
    Deregister a callback for SickScanNavPoseLandmarkMsg messages
    """ 
    return sick_scan_library.SickScanApiDeregisterNavPoseLandmarkMsg(api_handle, callback)
 
""" 
Diagnostic functions
""" 
 
def SickScanApiRegisterDiagnosticMsg(sick_scan_library, api_handle, callback):
    """ 
    Register a callback for diagnostic messages (notification in case of changed status, e.g. after errors)
    """ 
    return sick_scan_library.SickScanApiRegisterDiagnosticMsg(api_handle, callback)
 
def SickScanApiDeregisterDiagnosticMsg(sick_scan_library, api_handle, callback):
    """ 
    Deregister a callback for diagnostic messages (notification in case of changed status, e.g. after errors)
    """ 
    return sick_scan_library.SickScanApiDeregisterDiagnosticMsg(api_handle, callback)
 
def SickScanApiRegisterLogMsg(sick_scan_library, api_handle, callback):
    """ 
    Register a callback for log messages (all informational and error messages)
    """ 
    return sick_scan_library.SickScanApiRegisterLogMsg(api_handle, callback)
 
def SickScanApiDeregisterLogMsg(sick_scan_library, api_handle, callback):
    """ 
    Deregister a callback for log messages (all informational and error messages)
    """ 
    return sick_scan_library.SickScanApiDeregisterLogMsg(api_handle, callback)
 
def SickScanApiGetStatus(sick_scan_library, api_handle, status_code, message_buffer, message_buffer_size):
    """ 
    Query current status and status message
    """ 
    return sick_scan_library.SickScanApiGetStatus(api_handle, status_code, message_buffer, message_buffer_size)
 
# sopas_string_buffer = {}
def SickScanApiSendSOPAS(sick_scan_library, api_handle, sopas_command, response_buffer_size = 1024):
    """ 
    Sends a SOPAS command like "sRN SCdevicestate" or "sRN ContaminationResult" and returns the lidar response
    """ 
    response_buffer_size = max(1024, response_buffer_size)
    ctypes_response_buffer = ctypes.create_string_buffer(response_buffer_size + 1)
    ret_val = sick_scan_library.SickScanApiSendSOPAS(api_handle, ctypes.create_string_buffer(str.encode(sopas_command)), ctypes_response_buffer, response_buffer_size)
    # global sopas_string_buffer
    # if sopas_command not in sopas_string_buffer:
    #     sopas_string_buffer[sopas_command] = ctypes.create_string_buffer(str.encode(sopas_command))
    # ret_val = sick_scan_library.SickScanApiSendSOPAS(api_handle, sopas_string_buffer[sopas_command], ctypes_response_buffer, response_buffer_size)
    return ctypes_response_buffer.value.decode()
 
def SickScanApiSetVerboseLevel(sick_scan_library, api_handle, verbose_level):
    """ 
    Set verbose level 0=DEBUG, 1=INFO, 2=WARN, 3=ERROR, 4=FATAL or 5=QUIET (equivalent to ros::console::levels),
    i.e. print messages on console above the given verbose level.
    Default verbose level is 1 (INFO), i.e. print informational, warnings and error messages.
    """ 
    return sick_scan_library.SickScanApiSetVerboseLevel(api_handle, verbose_level)
 
def SickScanApiGetVerboseLevel(sick_scan_library, api_handle):
    """ 
    Returns the current verbose level 0=DEBUG, 1=INFO, 2=WARN, 3=ERROR, 4=FATAL or 5=QUIET. Default verbose level is 1 (INFO)
    """ 
    return sick_scan_library.SickScanApiGetVerboseLevel(api_handle)
 
""" 
Polling functions
""" 
 
def SickScanApiWaitNextCartesianPointCloudMsg(sick_scan_library, api_handle, msg, timeout_sec):
    """ 
    Wait for and return the next cartesian PointCloud message
    """ 
    return sick_scan_library.SickScanApiWaitNextCartesianPointCloudMsg(api_handle, msg, timeout_sec)
 
def SickScanApiWaitNextPolarPointCloudMsg(sick_scan_library, api_handle, msg, timeout_sec):
    """ 
    Wait for and return the next polar PointCloud message
    """ 
    return sick_scan_library.SickScanApiWaitNextPolarPointCloudMsg(api_handle, msg, timeout_sec)
 
def SickScanApiFreePointCloudMsg(sick_scan_library, api_handle, msg):
    """ 
    Deallocate a PointCloud message, use after SickScanApiWaitNextCartesianPointCloudMsg resp. SickScanApiWaitNextPolarPointCloudMsg
    """ 
    return sick_scan_library.SickScanApiFreePointCloudMsg(api_handle, msg)
 
def SickScanApiWaitNextImuMsg(sick_scan_library, api_handle, msg, timeout_sec):
    """ 
    Wait for and return the next Imu message
    """ 
    return sick_scan_library.SickScanApiWaitNextImuMsg(api_handle, msg, timeout_sec)
 
def SickScanApiFreeImuMsg(sick_scan_library, api_handle, msg):
    """ 
    Deallocate a Imu message, use after SickScanApiWaitNextImuMsg
    """ 
    return sick_scan_library.SickScanApiFreeImuMsg(api_handle, msg)
 
def SickScanApiWaitNextLFErecMsg(sick_scan_library, api_handle, msg, timeout_sec):
    """ 
    Wait for and return the next LFErec message
    """ 
    return sick_scan_library.SickScanApiWaitNextLFErecMsg(api_handle, msg, timeout_sec)
 
def SickScanApiFreeLFErecMsg(sick_scan_library, api_handle, msg):
    """ 
    Deallocate a LFErec message, use after SickScanApiWaitNextLFErecMsg
    """ 
    return sick_scan_library.SickScanApiFreeLFErecMsg(api_handle, msg)
 
def SickScanApiWaitNextLIDoutputstateMsg(sick_scan_library, api_handle, msg, timeout_sec):
    """ 
    Wait for and return the next LIDoutputstate message
    """ 
    return sick_scan_library.SickScanApiWaitNextLIDoutputstateMsg(api_handle, msg, timeout_sec)
 
def SickScanApiFreeLIDoutputstateMsg(sick_scan_library, api_handle, msg):
    """ 
    Deallocate a LIDoutputstate message, use after SickScanApiWaitNextLIDoutputstateMsg
    """ 
    return sick_scan_library.SickScanApiFreeLIDoutputstateMsg(api_handle, msg)
 
def SickScanApiWaitNextRadarScanMsg(sick_scan_library, api_handle, msg, timeout_sec):
    """ 
    Wait for and return the next RadarScan message
    """ 
    return sick_scan_library.SickScanApiWaitNextRadarScanMsg(api_handle, msg, timeout_sec)
 
def SickScanApiFreeRadarScanMsg(sick_scan_library, api_handle, msg):
    """ 
    Deallocate a RadarScan message, use after SickScanApiWaitNextRadarScanMsg
    """ 
    return sick_scan_library.SickScanApiFreeRadarScanMsg(api_handle, msg)
 
def SickScanApiWaitNextLdmrsObjectArrayMsg(sick_scan_library, api_handle, msg, timeout_sec):
    """ 
    Wait for and return the next LdmrsObjectArray message
    """ 
    return sick_scan_library.SickScanApiWaitNextLdmrsObjectArrayMsg(api_handle, msg, timeout_sec)
 
def SickScanApiFreeLdmrsObjectArrayMsg(sick_scan_library, api_handle, msg):
    """ 
    Deallocate a LdmrsObjectArray message, use after SickScanApiWaitNextLdmrsObjectArrayMsg
    """ 
    return sick_scan_library.SickScanApiFreeLdmrsObjectArrayMsg(api_handle, msg)
 
def SickScanApiWaitNextVisualizationMarkerMsg(sick_scan_library, api_handle, msg, timeout_sec):
    """ 
    Wait for and return the next VisualizationMarker message
    """ 
    return sick_scan_library.SickScanApiWaitNextVisualizationMarkerMsg(api_handle, msg, timeout_sec)
 
def SickScanApiFreeVisualizationMarkerMsg(sick_scan_library, api_handle, msg):
    """ 
    Deallocate a VisualizationMarker message, use after SickScanApiWaitNextVisualizationMarkerMsg
    """ 
    return sick_scan_library.SickScanApiFreeVisualizationMarkerMsg(api_handle, msg)
 
def SickScanApiWaitNextNavPoseLandmarkMsg(sick_scan_library, api_handle, msg, timeout_sec):
    """ 
    Wait for and return the next SickScanNavPoseLandmarkMsg message
    """ 
    return sick_scan_library.SickScanApiWaitNextNavPoseLandmarkMsg(api_handle, msg, timeout_sec)
 
def SickScanApiFreeNavPoseLandmarkMsg(sick_scan_library, api_handle, msg):
    """ 
    Deallocate a SickScanNavPoseLandmarkMsg message, use after SickScanApiWaitNextNavPoseLandmarkMsg
    """ 
    return sick_scan_library.SickScanApiFreeNavPoseLandmarkMsg(api_handle, msg)
 
def SickScanApiNavOdomVelocityMsg(sick_scan_library, api_handle, msg):
    """ 
    Send NAV350 velocity/odometry data in nav coordinates
    """ 
    return sick_scan_library.SickScanApiNavOdomVelocityMsg(api_handle, msg)
 
def SickScanApiOdomVelocityMsg(sick_scan_library, api_handle, msg):
    """ 
    Send velocity/odometry data in ros coordinates
    """ 
    return sick_scan_library.SickScanApiOdomVelocityMsg(api_handle, msg)