Classes | |
class | SickScanApiErrorCodes |
class | SickScanColorRGBA |
class | SickScanColorRGBAArray |
class | SickScanDiagnosticMsg |
class | SickScanHeader |
class | SickScanImuMsg |
class | SickScanLdmrsObject |
class | SickScanLdmrsObjectArray |
class | SickScanLdmrsObjectBuffer |
class | SickScanLFErecFieldMsg |
class | SickScanLFErecMsg |
class | SickScanLIDoutputstateMsg |
class | SickScanLogMsg |
class | SickScanNativeDataType |
class | SickScanNavOdomVelocityMsg |
class | SickScanNavPoseLandmarkMsg |
class | SickScanNavReflector |
class | SickScanNavReflectorBuffer |
class | SickScanOdomVelocityMsg |
class | SickScanPointArray |
class | SickScanPointCloudMsg |
class | SickScanPointFieldArray |
class | SickScanPointFieldMsg |
class | SickScanQuaternionMsg |
class | SickScanRadarObject |
class | SickScanRadarObjectArray |
class | SickScanRadarPreHeader |
class | SickScanRadarScan |
class | SickScanUint8Array |
class | SickScanVector3Msg |
class | SickScanVisualizationMarker |
class | SickScanVisualizationMarkerBuffer |
class | SickScanVisualizationMarkerMsg |
Functions | |
def | ctypesCharArrayToString (char_array) |
def | loadLibrary (paths, lib_filname) |
def | SickScanApiClose (sick_scan_library, api_handle) |
def | SickScanApiCreate (sick_scan_library) |
def | SickScanApiDeregisterCartesianPointCloudMsg (sick_scan_library, api_handle, pointcloud_callback) |
def | SickScanApiDeregisterDiagnosticMsg (sick_scan_library, api_handle, callback) |
def | SickScanApiDeregisterImuMsg (sick_scan_library, api_handle, imu_callback) |
def | SickScanApiDeregisterLdmrsObjectArrayMsg (sick_scan_library, api_handle, ldmrsobjectarray_callback) |
def | SickScanApiDeregisterLFErecMsg (sick_scan_library, api_handle, lferec_callback) |
def | SickScanApiDeregisterLIDoutputstateMsg (sick_scan_library, api_handle, lidoutputstate_callback) |
def | SickScanApiDeregisterLogMsg (sick_scan_library, api_handle, callback) |
def | SickScanApiDeregisterNavPoseLandmarkMsg (sick_scan_library, api_handle, callback) |
def | SickScanApiDeregisterPolarPointCloudMsg (sick_scan_library, api_handle, pointcloud_callback) |
def | SickScanApiDeregisterRadarScanMsg (sick_scan_library, api_handle, radarscan_callback) |
def | SickScanApiDeregisterVisualizationMarkerMsg (sick_scan_library, api_handle, ldmrsobjectarray_callback) |
def | SickScanApiFreeImuMsg (sick_scan_library, api_handle, msg) |
def | SickScanApiFreeLdmrsObjectArrayMsg (sick_scan_library, api_handle, msg) |
def | SickScanApiFreeLFErecMsg (sick_scan_library, api_handle, msg) |
def | SickScanApiFreeLIDoutputstateMsg (sick_scan_library, api_handle, msg) |
def | SickScanApiFreeNavPoseLandmarkMsg (sick_scan_library, api_handle, msg) |
def | SickScanApiFreePointCloudMsg (sick_scan_library, api_handle, msg) |
def | SickScanApiFreeRadarScanMsg (sick_scan_library, api_handle, msg) |
def | SickScanApiFreeVisualizationMarkerMsg (sick_scan_library, api_handle, msg) |
def | SickScanApiGetStatus (sick_scan_library, api_handle, status_code, message_buffer, message_buffer_size) |
def | SickScanApiGetVerboseLevel (sick_scan_library, api_handle) |
def | SickScanApiInitByLaunchfile (sick_scan_library, api_handle, launchfile_args) |
def | SickScanApiLoadLibrary (paths, lib_filname) |
def | SickScanApiNavOdomVelocityMsg (sick_scan_library, api_handle, msg) |
def | SickScanApiOdomVelocityMsg (sick_scan_library, api_handle, msg) |
def | SickScanApiRegisterCartesianPointCloudMsg (sick_scan_library, api_handle, pointcloud_callback) |
def | SickScanApiRegisterDiagnosticMsg (sick_scan_library, api_handle, callback) |
def | SickScanApiRegisterImuMsg (sick_scan_library, api_handle, imu_callback) |
def | SickScanApiRegisterLdmrsObjectArrayMsg (sick_scan_library, api_handle, ldmrsobjectarray_callback) |
def | SickScanApiRegisterLFErecMsg (sick_scan_library, api_handle, lferec_callback) |
def | SickScanApiRegisterLIDoutputstateMsg (sick_scan_library, api_handle, lidoutputstate_callback) |
def | SickScanApiRegisterLogMsg (sick_scan_library, api_handle, callback) |
def | SickScanApiRegisterNavPoseLandmarkMsg (sick_scan_library, api_handle, callback) |
def | SickScanApiRegisterPolarPointCloudMsg (sick_scan_library, api_handle, pointcloud_callback) |
def | SickScanApiRegisterRadarScanMsg (sick_scan_library, api_handle, radarscan_callback) |
def | SickScanApiRegisterVisualizationMarkerMsg (sick_scan_library, api_handle, ldmrsobjectarray_callback) |
def | SickScanApiRelease (sick_scan_library, api_handle) |
def | SickScanApiSendSOPAS (sick_scan_library, api_handle, sopas_command, response_buffer_size=1024) |
def | SickScanApiSetVerboseLevel (sick_scan_library, api_handle, verbose_level) |
def | SickScanApiUnloadLibrary (sick_scan_library) |
def | SickScanApiWaitNextCartesianPointCloudMsg (sick_scan_library, api_handle, msg, timeout_sec) |
def | SickScanApiWaitNextImuMsg (sick_scan_library, api_handle, msg, timeout_sec) |
def | SickScanApiWaitNextLdmrsObjectArrayMsg (sick_scan_library, api_handle, msg, timeout_sec) |
def | SickScanApiWaitNextLFErecMsg (sick_scan_library, api_handle, msg, timeout_sec) |
def | SickScanApiWaitNextLIDoutputstateMsg (sick_scan_library, api_handle, msg, timeout_sec) |
def | SickScanApiWaitNextNavPoseLandmarkMsg (sick_scan_library, api_handle, msg, timeout_sec) |
def | SickScanApiWaitNextPolarPointCloudMsg (sick_scan_library, api_handle, msg, timeout_sec) |
def | SickScanApiWaitNextRadarScanMsg (sick_scan_library, api_handle, msg, timeout_sec) |
def | SickScanApiWaitNextVisualizationMarkerMsg (sick_scan_library, api_handle, msg, timeout_sec) |
Variables | |
SickScanDiagnosticMsgCallback = ctypes.CFUNCTYPE(None, ctypes.c_void_p, ctypes.POINTER(SickScanDiagnosticMsg)) | |
SickScanImuMsgCallback = ctypes.CFUNCTYPE(None, ctypes.c_void_p, ctypes.POINTER(SickScanImuMsg)) | |
SickScanLdmrsObjectArrayCallback = ctypes.CFUNCTYPE(None, ctypes.c_void_p, ctypes.POINTER(SickScanLdmrsObjectArray)) | |
SickScanLFErecMsgCallback = ctypes.CFUNCTYPE(None, ctypes.c_void_p, ctypes.POINTER(SickScanLFErecMsg)) | |
SickScanLIDoutputstateMsgCallback = ctypes.CFUNCTYPE(None, ctypes.c_void_p, ctypes.POINTER(SickScanLIDoutputstateMsg)) | |
SickScanLogMsgCallback = ctypes.CFUNCTYPE(None, ctypes.c_void_p, ctypes.POINTER(SickScanLogMsg)) | |
SickScanNavPoseLandmarkCallback = ctypes.CFUNCTYPE(None, ctypes.c_void_p, ctypes.POINTER(SickScanNavPoseLandmarkMsg)) | |
SickScanPointCloudMsgCallback = ctypes.CFUNCTYPE(None, ctypes.c_void_p, ctypes.POINTER(SickScanPointCloudMsg)) | |
SickScanRadarScanCallback = ctypes.CFUNCTYPE(None, ctypes.c_void_p, ctypes.POINTER(SickScanRadarScan)) | |
SickScanVisualizationMarkerCallback = ctypes.CFUNCTYPE(None, ctypes.c_void_p, ctypes.POINTER(SickScanVisualizationMarkerMsg)) | |
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.
def api.sick_scan_api.ctypesCharArrayToString | ( | char_array | ) |
Returns a python string from a zero terminated ctypes char array
Definition at line 882 of file sick_scan_api.py.
def api.sick_scan_api.loadLibrary | ( | paths, | |
lib_filname | |||
) |
loads and returns a library, given its filename and a list of folder
Definition at line 888 of file sick_scan_api.py.
def api.sick_scan_api.SickScanApiClose | ( | sick_scan_library, | |
api_handle | |||
) |
Release and free all resources of the api handle; the handle is invalid after SickScanApiRelease
Definition at line 1082 of file sick_scan_api.py.
def api.sick_scan_api.SickScanApiCreate | ( | sick_scan_library | ) |
Create an instance of sick_scan_xd api. Call SickScanApiInitByLaunchfile or SickScanApiInitByCli to process a lidar.
Definition at line 1061 of file sick_scan_api.py.
def api.sick_scan_api.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
Definition at line 1098 of file sick_scan_api.py.
def api.sick_scan_api.SickScanApiDeregisterDiagnosticMsg | ( | sick_scan_library, | |
api_handle, | |||
callback | |||
) |
Deregister a callback for diagnostic messages (notification in case of changed status, e.g. after errors)
Definition at line 1210 of file sick_scan_api.py.
def api.sick_scan_api.SickScanApiDeregisterImuMsg | ( | sick_scan_library, | |
api_handle, | |||
imu_callback | |||
) |
def api.sick_scan_api.SickScanApiDeregisterLdmrsObjectArrayMsg | ( | sick_scan_library, | |
api_handle, | |||
ldmrsobjectarray_callback | |||
) |
Deregister a callback for LdmrsObjectArray messages
Definition at line 1170 of file sick_scan_api.py.
def api.sick_scan_api.SickScanApiDeregisterLFErecMsg | ( | sick_scan_library, | |
api_handle, | |||
lferec_callback | |||
) |
def api.sick_scan_api.SickScanApiDeregisterLIDoutputstateMsg | ( | sick_scan_library, | |
api_handle, | |||
lidoutputstate_callback | |||
) |
def api.sick_scan_api.SickScanApiDeregisterLogMsg | ( | sick_scan_library, | |
api_handle, | |||
callback | |||
) |
Deregister a callback for log messages (all informational and error messages)
Definition at line 1222 of file sick_scan_api.py.
def api.sick_scan_api.SickScanApiDeregisterNavPoseLandmarkMsg | ( | sick_scan_library, | |
api_handle, | |||
callback | |||
) |
Deregister a callback for SickScanNavPoseLandmarkMsg messages
Definition at line 1194 of file sick_scan_api.py.
def api.sick_scan_api.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
Definition at line 1110 of file sick_scan_api.py.
def api.sick_scan_api.SickScanApiDeregisterRadarScanMsg | ( | sick_scan_library, | |
api_handle, | |||
radarscan_callback | |||
) |
def api.sick_scan_api.SickScanApiDeregisterVisualizationMarkerMsg | ( | sick_scan_library, | |
api_handle, | |||
ldmrsobjectarray_callback | |||
) |
Deregister a callback for VisualizationMarker messages
Definition at line 1182 of file sick_scan_api.py.
def api.sick_scan_api.SickScanApiFreeImuMsg | ( | sick_scan_library, | |
api_handle, | |||
msg | |||
) |
Deallocate a Imu message, use after SickScanApiWaitNextImuMsg
Definition at line 1290 of file sick_scan_api.py.
def api.sick_scan_api.SickScanApiFreeLdmrsObjectArrayMsg | ( | sick_scan_library, | |
api_handle, | |||
msg | |||
) |
Deallocate a LdmrsObjectArray message, use after SickScanApiWaitNextLdmrsObjectArrayMsg
Definition at line 1338 of file sick_scan_api.py.
def api.sick_scan_api.SickScanApiFreeLFErecMsg | ( | sick_scan_library, | |
api_handle, | |||
msg | |||
) |
Deallocate a LFErec message, use after SickScanApiWaitNextLFErecMsg
Definition at line 1302 of file sick_scan_api.py.
def api.sick_scan_api.SickScanApiFreeLIDoutputstateMsg | ( | sick_scan_library, | |
api_handle, | |||
msg | |||
) |
Deallocate a LIDoutputstate message, use after SickScanApiWaitNextLIDoutputstateMsg
Definition at line 1314 of file sick_scan_api.py.
def api.sick_scan_api.SickScanApiFreeNavPoseLandmarkMsg | ( | sick_scan_library, | |
api_handle, | |||
msg | |||
) |
Deallocate a SickScanNavPoseLandmarkMsg message, use after SickScanApiWaitNextNavPoseLandmarkMsg
Definition at line 1362 of file sick_scan_api.py.
def api.sick_scan_api.SickScanApiFreePointCloudMsg | ( | sick_scan_library, | |
api_handle, | |||
msg | |||
) |
Deallocate a PointCloud message, use after SickScanApiWaitNextCartesianPointCloudMsg resp. SickScanApiWaitNextPolarPointCloudMsg
Definition at line 1278 of file sick_scan_api.py.
def api.sick_scan_api.SickScanApiFreeRadarScanMsg | ( | sick_scan_library, | |
api_handle, | |||
msg | |||
) |
Deallocate a RadarScan message, use after SickScanApiWaitNextRadarScanMsg
Definition at line 1326 of file sick_scan_api.py.
def api.sick_scan_api.SickScanApiFreeVisualizationMarkerMsg | ( | sick_scan_library, | |
api_handle, | |||
msg | |||
) |
Deallocate a VisualizationMarker message, use after SickScanApiWaitNextVisualizationMarkerMsg
Definition at line 1350 of file sick_scan_api.py.
def api.sick_scan_api.SickScanApiGetStatus | ( | sick_scan_library, | |
api_handle, | |||
status_code, | |||
message_buffer, | |||
message_buffer_size | |||
) |
def api.sick_scan_api.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)
Definition at line 1256 of file sick_scan_api.py.
def api.sick_scan_api.SickScanApiInitByLaunchfile | ( | sick_scan_library, | |
api_handle, | |||
launchfile_args | |||
) |
Initialize a lidar by launchfile and start message receiving and processing
Definition at line 1076 of file sick_scan_api.py.
def api.sick_scan_api.SickScanApiLoadLibrary | ( | paths, | |
lib_filname | |||
) |
def api.sick_scan_api.SickScanApiNavOdomVelocityMsg | ( | sick_scan_library, | |
api_handle, | |||
msg | |||
) |
Send NAV350 velocity/odometry data in nav coordinates
Definition at line 1368 of file sick_scan_api.py.
def api.sick_scan_api.SickScanApiOdomVelocityMsg | ( | sick_scan_library, | |
api_handle, | |||
msg | |||
) |
def api.sick_scan_api.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
Definition at line 1092 of file sick_scan_api.py.
def api.sick_scan_api.SickScanApiRegisterDiagnosticMsg | ( | sick_scan_library, | |
api_handle, | |||
callback | |||
) |
Register a callback for diagnostic messages (notification in case of changed status, e.g. after errors)
Definition at line 1204 of file sick_scan_api.py.
def api.sick_scan_api.SickScanApiRegisterImuMsg | ( | sick_scan_library, | |
api_handle, | |||
imu_callback | |||
) |
def api.sick_scan_api.SickScanApiRegisterLdmrsObjectArrayMsg | ( | sick_scan_library, | |
api_handle, | |||
ldmrsobjectarray_callback | |||
) |
def api.sick_scan_api.SickScanApiRegisterLFErecMsg | ( | sick_scan_library, | |
api_handle, | |||
lferec_callback | |||
) |
def api.sick_scan_api.SickScanApiRegisterLIDoutputstateMsg | ( | sick_scan_library, | |
api_handle, | |||
lidoutputstate_callback | |||
) |
def api.sick_scan_api.SickScanApiRegisterLogMsg | ( | sick_scan_library, | |
api_handle, | |||
callback | |||
) |
Register a callback for log messages (all informational and error messages)
Definition at line 1216 of file sick_scan_api.py.
def api.sick_scan_api.SickScanApiRegisterNavPoseLandmarkMsg | ( | sick_scan_library, | |
api_handle, | |||
callback | |||
) |
Register a callback for SickScanNavPoseLandmarkMsg messages
Definition at line 1188 of file sick_scan_api.py.
def api.sick_scan_api.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
Definition at line 1104 of file sick_scan_api.py.
def api.sick_scan_api.SickScanApiRegisterRadarScanMsg | ( | sick_scan_library, | |
api_handle, | |||
radarscan_callback | |||
) |
def api.sick_scan_api.SickScanApiRegisterVisualizationMarkerMsg | ( | sick_scan_library, | |
api_handle, | |||
ldmrsobjectarray_callback | |||
) |
Register a callback for VisualizationMarker messages
Definition at line 1176 of file sick_scan_api.py.
def api.sick_scan_api.SickScanApiRelease | ( | sick_scan_library, | |
api_handle | |||
) |
Release and free all resources of the api handle; the handle is invalid after SickScanApiRelease
Definition at line 1070 of file sick_scan_api.py.
def api.sick_scan_api.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
Definition at line 1235 of file sick_scan_api.py.
def api.sick_scan_api.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.
Definition at line 1248 of file sick_scan_api.py.
def api.sick_scan_api.SickScanApiUnloadLibrary | ( | sick_scan_library | ) |
def api.sick_scan_api.SickScanApiWaitNextCartesianPointCloudMsg | ( | sick_scan_library, | |
api_handle, | |||
msg, | |||
timeout_sec | |||
) |
Wait for and return the next cartesian PointCloud message
Definition at line 1266 of file sick_scan_api.py.
def api.sick_scan_api.SickScanApiWaitNextImuMsg | ( | sick_scan_library, | |
api_handle, | |||
msg, | |||
timeout_sec | |||
) |
def api.sick_scan_api.SickScanApiWaitNextLdmrsObjectArrayMsg | ( | sick_scan_library, | |
api_handle, | |||
msg, | |||
timeout_sec | |||
) |
Wait for and return the next LdmrsObjectArray message
Definition at line 1332 of file sick_scan_api.py.
def api.sick_scan_api.SickScanApiWaitNextLFErecMsg | ( | sick_scan_library, | |
api_handle, | |||
msg, | |||
timeout_sec | |||
) |
def api.sick_scan_api.SickScanApiWaitNextLIDoutputstateMsg | ( | sick_scan_library, | |
api_handle, | |||
msg, | |||
timeout_sec | |||
) |
Wait for and return the next LIDoutputstate message
Definition at line 1308 of file sick_scan_api.py.
def api.sick_scan_api.SickScanApiWaitNextNavPoseLandmarkMsg | ( | sick_scan_library, | |
api_handle, | |||
msg, | |||
timeout_sec | |||
) |
Wait for and return the next SickScanNavPoseLandmarkMsg message
Definition at line 1356 of file sick_scan_api.py.
def api.sick_scan_api.SickScanApiWaitNextPolarPointCloudMsg | ( | sick_scan_library, | |
api_handle, | |||
msg, | |||
timeout_sec | |||
) |
Wait for and return the next polar PointCloud message
Definition at line 1272 of file sick_scan_api.py.
def api.sick_scan_api.SickScanApiWaitNextRadarScanMsg | ( | sick_scan_library, | |
api_handle, | |||
msg, | |||
timeout_sec | |||
) |
def api.sick_scan_api.SickScanApiWaitNextVisualizationMarkerMsg | ( | sick_scan_library, | |
api_handle, | |||
msg, | |||
timeout_sec | |||
) |
Wait for and return the next VisualizationMarker message
Definition at line 1344 of file sick_scan_api.py.
api.sick_scan_api.SickScanDiagnosticMsgCallback = ctypes.CFUNCTYPE(None, ctypes.c_void_p, ctypes.POINTER(SickScanDiagnosticMsg)) |
Definition at line 875 of file sick_scan_api.py.
api.sick_scan_api.SickScanImuMsgCallback = ctypes.CFUNCTYPE(None, ctypes.c_void_p, ctypes.POINTER(SickScanImuMsg)) |
Definition at line 867 of file sick_scan_api.py.
api.sick_scan_api.SickScanLdmrsObjectArrayCallback = ctypes.CFUNCTYPE(None, ctypes.c_void_p, ctypes.POINTER(SickScanLdmrsObjectArray)) |
Definition at line 871 of file sick_scan_api.py.
api.sick_scan_api.SickScanLFErecMsgCallback = ctypes.CFUNCTYPE(None, ctypes.c_void_p, ctypes.POINTER(SickScanLFErecMsg)) |
Definition at line 868 of file sick_scan_api.py.
api.sick_scan_api.SickScanLIDoutputstateMsgCallback = ctypes.CFUNCTYPE(None, ctypes.c_void_p, ctypes.POINTER(SickScanLIDoutputstateMsg)) |
Definition at line 869 of file sick_scan_api.py.
api.sick_scan_api.SickScanLogMsgCallback = ctypes.CFUNCTYPE(None, ctypes.c_void_p, ctypes.POINTER(SickScanLogMsg)) |
Definition at line 874 of file sick_scan_api.py.
api.sick_scan_api.SickScanNavPoseLandmarkCallback = ctypes.CFUNCTYPE(None, ctypes.c_void_p, ctypes.POINTER(SickScanNavPoseLandmarkMsg)) |
Definition at line 873 of file sick_scan_api.py.
api.sick_scan_api.SickScanPointCloudMsgCallback = ctypes.CFUNCTYPE(None, ctypes.c_void_p, ctypes.POINTER(SickScanPointCloudMsg)) |
Definition at line 866 of file sick_scan_api.py.
api.sick_scan_api.SickScanRadarScanCallback = ctypes.CFUNCTYPE(None, ctypes.c_void_p, ctypes.POINTER(SickScanRadarScan)) |
Definition at line 870 of file sick_scan_api.py.
api.sick_scan_api.SickScanVisualizationMarkerCallback = ctypes.CFUNCTYPE(None, ctypes.c_void_p, ctypes.POINTER(SickScanVisualizationMarkerMsg)) |
Definition at line 872 of file sick_scan_api.py.