Protocol.h File Reference

#include <stdint.h>
#include "../utility/Portability.hh"

Include dependency graph for Protocol.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces
namespace	crl
namespace	crl::multisense
namespace	crl::multisense::details
namespace	crl::multisense::details::wire
Defines
#define	CPY_ARRAY_1(d_, s_, n_)
#define	CPY_ARRAY_2(d_, s_, n_, m_)
#define	MSG_ID(x)   ((wire::IdType)(x))
#define	MSG_VER(x)   ((wire::VersionType)(x))
#define	SER_ARRAY_1(a_, n_)
#define	SER_ARRAY_2(a_, n_, m_)
#define	WIRE_HEADER_ATTRIBS_
Typedefs
typedef uint16_t	crl::multisense::details::wire::IdType
typedef uint32_t	crl::multisense::details::wire::SourceType
typedef uint16_t	crl::multisense::details::wire::VersionType
Functions
struct	crl::multisense::details::wire::__attribute__ ((__packed__))
Variables
static CRL_CONSTEXPR uint8_t	crl::multisense::details::wire::COMBINED_HEADER_LENGTH = 60
	crl::multisense::details::wire::Header
static CRL_CONSTEXPR uint16_t	crl::multisense::details::wire::HEADER_GROUP = 0x0001
static CRL_CONSTEXPR uint16_t	crl::multisense::details::wire::HEADER_MAGIC = 0xadad
static CRL_CONSTEXPR uint16_t	crl::multisense::details::wire::HEADER_VERSION = 0x0100
static CRL_CONSTEXPR IdType	crl::multisense::details::wire::ID_ACK = 0x0001
static CRL_CONSTEXPR IdType	crl::multisense::details::wire::ID_CMD_CAM_CONTROL = 0x0007
static CRL_CONSTEXPR IdType	crl::multisense::details::wire::ID_CMD_CAM_GET_CONFIG = 0x0004
static CRL_CONSTEXPR IdType	crl::multisense::details::wire::ID_CMD_CAM_GET_HISTORY = 0x0008
static CRL_CONSTEXPR IdType	crl::multisense::details::wire::ID_CMD_CAM_SET_HDR = 0x000b
static CRL_CONSTEXPR IdType	crl::multisense::details::wire::ID_CMD_CAM_SET_RESOLUTION = 0x000c
static CRL_CONSTEXPR IdType	crl::multisense::details::wire::ID_CMD_CAM_SET_TRIGGER_SOURCE = 0x001e
static CRL_CONSTEXPR IdType	crl::multisense::details::wire::ID_CMD_GET_STATUS = 0x0003
static CRL_CONSTEXPR IdType	crl::multisense::details::wire::ID_CMD_GET_VERSION = 0x0002
static CRL_CONSTEXPR IdType	crl::multisense::details::wire::ID_CMD_IMU_GET_CONFIG = 0x0020
static CRL_CONSTEXPR IdType	crl::multisense::details::wire::ID_CMD_IMU_GET_INFO = 0x001f
static CRL_CONSTEXPR IdType	crl::multisense::details::wire::ID_CMD_LED_GET_SENSOR_STATUS = 0x0025
static CRL_CONSTEXPR IdType	crl::multisense::details::wire::ID_CMD_LED_GET_STATUS = 0x0012
static CRL_CONSTEXPR IdType	crl::multisense::details::wire::ID_CMD_LED_SET = 0x0013
static CRL_CONSTEXPR IdType	crl::multisense::details::wire::ID_CMD_LIDAR_GET_CONFIG = 0x000d
static CRL_CONSTEXPR IdType	crl::multisense::details::wire::ID_CMD_LIDAR_SET_MOTOR = 0x0010
static CRL_CONSTEXPR IdType	crl::multisense::details::wire::ID_CMD_STREAM_CONTROL = 0x001c
static CRL_CONSTEXPR IdType	crl::multisense::details::wire::ID_CMD_SYS_FLASH_OP = 0x0015
static CRL_CONSTEXPR IdType	crl::multisense::details::wire::ID_CMD_SYS_GET_CAMERA_CAL = 0x0018
static CRL_CONSTEXPR IdType	crl::multisense::details::wire::ID_CMD_SYS_GET_DEVICE_INFO = 0x0017
static CRL_CONSTEXPR IdType	crl::multisense::details::wire::ID_CMD_SYS_GET_DEVICE_MODES = 0x001d
static CRL_CONSTEXPR IdType	crl::multisense::details::wire::ID_CMD_SYS_GET_DIRECTED_STREAMS = 0x0022
static CRL_CONSTEXPR IdType	crl::multisense::details::wire::ID_CMD_SYS_GET_EXTERNAL_CAL = 0x0024
static CRL_CONSTEXPR IdType	crl::multisense::details::wire::ID_CMD_SYS_GET_LIDAR_CAL = 0x0019
static CRL_CONSTEXPR IdType	crl::multisense::details::wire::ID_CMD_SYS_GET_MTU = 0x001a
static CRL_CONSTEXPR IdType	crl::multisense::details::wire::ID_CMD_SYS_GET_NETWORK = 0x001b
static CRL_CONSTEXPR IdType	crl::multisense::details::wire::ID_CMD_SYS_GET_SENSOR_CAL = 0x0023
static CRL_CONSTEXPR IdType	crl::multisense::details::wire::ID_CMD_SYS_GET_TRANSMIT_DELAY = 0x0027
static CRL_CONSTEXPR IdType	crl::multisense::details::wire::ID_CMD_SYS_MTU = 0x0014
static CRL_CONSTEXPR IdType	crl::multisense::details::wire::ID_CMD_SYS_SET_NETWORK = 0x0016
static CRL_CONSTEXPR IdType	crl::multisense::details::wire::ID_CMD_SYS_SET_TRANSMIT_DELAY = 0x0026
static CRL_CONSTEXPR IdType	crl::multisense::details::wire::ID_CMD_SYS_TEST_MTU = 0x0021
static CRL_CONSTEXPR IdType	crl::multisense::details::wire::ID_DATA_CAM_CONFIG = 0x0104
static CRL_CONSTEXPR IdType	crl::multisense::details::wire::ID_DATA_CAM_HISTORY = 0x0105
static CRL_CONSTEXPR IdType	crl::multisense::details::wire::ID_DATA_DISPARITY = 0x0111
static CRL_CONSTEXPR IdType	crl::multisense::details::wire::ID_DATA_IMAGE = 0x0110
static CRL_CONSTEXPR IdType	crl::multisense::details::wire::ID_DATA_IMAGE_META = 0x010f
static CRL_CONSTEXPR IdType	crl::multisense::details::wire::ID_DATA_IMU = 0x0114
static CRL_CONSTEXPR IdType	crl::multisense::details::wire::ID_DATA_IMU_CONFIG = 0x0116
static CRL_CONSTEXPR IdType	crl::multisense::details::wire::ID_DATA_IMU_INFO = 0x0115
static CRL_CONSTEXPR IdType	crl::multisense::details::wire::ID_DATA_JPEG_IMAGE = 0x0118
static CRL_CONSTEXPR IdType	crl::multisense::details::wire::ID_DATA_LED_SENSOR_STATUS = 0x011c
static CRL_CONSTEXPR IdType	crl::multisense::details::wire::ID_DATA_LED_STATUS = 0x010a
static CRL_CONSTEXPR IdType	crl::multisense::details::wire::ID_DATA_LIDAR_CONFIG = 0x0108
static CRL_CONSTEXPR IdType	crl::multisense::details::wire::ID_DATA_LIDAR_SCAN = 0x0109
static CRL_CONSTEXPR IdType	crl::multisense::details::wire::ID_DATA_STATUS = 0x0103
static CRL_CONSTEXPR IdType	crl::multisense::details::wire::ID_DATA_SYS_CAMERA_CAL = 0x010d
static CRL_CONSTEXPR IdType	crl::multisense::details::wire::ID_DATA_SYS_DEVICE_INFO = 0x010c
static CRL_CONSTEXPR IdType	crl::multisense::details::wire::ID_DATA_SYS_DEVICE_MODES = 0x0112
static CRL_CONSTEXPR IdType	crl::multisense::details::wire::ID_DATA_SYS_DIRECTED_STREAMS = 0x0119
static CRL_CONSTEXPR IdType	crl::multisense::details::wire::ID_DATA_SYS_EXTERNAL_CAL = 0x011b
static CRL_CONSTEXPR IdType	crl::multisense::details::wire::ID_DATA_SYS_FLASH_RESPONSE = 0x010b
static CRL_CONSTEXPR IdType	crl::multisense::details::wire::ID_DATA_SYS_LIDAR_CAL = 0x010e
static CRL_CONSTEXPR IdType	crl::multisense::details::wire::ID_DATA_SYS_PPS = 0x0113
static CRL_CONSTEXPR IdType	crl::multisense::details::wire::ID_DATA_SYS_SENSOR_CAL = 0x011a
static CRL_CONSTEXPR IdType	crl::multisense::details::wire::ID_DATA_SYS_TEST_MTU_RESPONSE = 0x0117
static CRL_CONSTEXPR IdType	crl::multisense::details::wire::ID_DATA_VERSION = 0x0102
static CRL_CONSTEXPR SourceType	crl::multisense::details::wire::SOURCE_CHROMA_LEFT = (1<<6)
static CRL_CONSTEXPR SourceType	crl::multisense::details::wire::SOURCE_CHROMA_RIGHT = (1<<7)
static CRL_CONSTEXPR SourceType	crl::multisense::details::wire::SOURCE_DISPARITY = (1<<10)
static CRL_CONSTEXPR SourceType	crl::multisense::details::wire::SOURCE_DISPARITY_COST = (1<<12)
static CRL_CONSTEXPR SourceType	crl::multisense::details::wire::SOURCE_DISPARITY_LEFT = (1<<10)
static CRL_CONSTEXPR SourceType	crl::multisense::details::wire::SOURCE_DISPARITY_RIGHT = (1<<11)
static CRL_CONSTEXPR SourceType	crl::multisense::details::wire::SOURCE_IMAGES
static CRL_CONSTEXPR SourceType	crl::multisense::details::wire::SOURCE_IMU = (1<<25)
static CRL_CONSTEXPR SourceType	crl::multisense::details::wire::SOURCE_JPEG_LEFT = (1<<16)
static CRL_CONSTEXPR SourceType	crl::multisense::details::wire::SOURCE_LIDAR_SCAN = (1<<24)
static CRL_CONSTEXPR SourceType	crl::multisense::details::wire::SOURCE_LUMA_LEFT = (1<<2)
static CRL_CONSTEXPR SourceType	crl::multisense::details::wire::SOURCE_LUMA_RECT_LEFT = (1<<4)
static CRL_CONSTEXPR SourceType	crl::multisense::details::wire::SOURCE_LUMA_RECT_RIGHT = (1<<5)
static CRL_CONSTEXPR SourceType	crl::multisense::details::wire::SOURCE_LUMA_RIGHT = (1<<3)
static CRL_CONSTEXPR SourceType	crl::multisense::details::wire::SOURCE_PPS = (1<<26)
static CRL_CONSTEXPR SourceType	crl::multisense::details::wire::SOURCE_RAW_LEFT = (1<<0)
static CRL_CONSTEXPR SourceType	crl::multisense::details::wire::SOURCE_RAW_RIGHT = (1<<1)
static CRL_CONSTEXPR SourceType	crl::multisense::details::wire::SOURCE_RGB_LEFT = (1<<17)
static CRL_CONSTEXPR SourceType	crl::multisense::details::wire::SOURCE_UNKNOWN = 0

---

Detailed Description

Copyright 2013 Carnegie Robotics, LLC 4501 Hatfield Street, Pittsburgh, PA 15201 http://www.carnegierobotics.com

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of the Carnegie Robotics, LLC nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL CARNEGIE ROBOTICS, LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Significant history (date, user, job code, action): 2013-05-07, ekratzer@carnegierobotics.com, PR1044, Created file.

Definition in file Protocol.h.

---

Define Documentation

#define CPY_ARRAY_1	(		d_,
			s_,
			n_
	)

Value:

for(uint32_t i_=0; i_<(n_); i_++)           \
        (d_)[i_] = (s_)[i_];                    \

Definition at line 260 of file Protocol.h.

#define CPY_ARRAY_2	(		d_,
			s_,
			n_,
			m_
	)

Value:

for(uint32_t i_=0; i_<(n_); i_++)           \
        for(uint32_t j_=0; j_<(m_); j_++)       \
            (d_)[i_][j_] = (s_)[i_][j_];        \

Definition at line 264 of file Protocol.h.

#define MSG_ID

(

x

)

((wire::IdType)(x))

Definition at line 248 of file Protocol.h.

#define MSG_VER

(

x

)

((wire::VersionType)(x))

Definition at line 249 of file Protocol.h.

#define SER_ARRAY_1	(		a_,
			n_
	)

Value:

for(uint32_t i_=0; i_<(n_); i_++)         \
        message & (a_)[i_];                   \

Definition at line 251 of file Protocol.h.

#define SER_ARRAY_2	(		a_,
			n_,
			m_
	)

Value:

for(uint32_t i_=0; i_<(n_); i_++)         \
        for(uint32_t j_=0; j_<(m_); j_++)     \
            message & (a_)[(i_)][(j_)];       \

Definition at line 255 of file Protocol.h.

#define WIRE_HEADER_ATTRIBS_

Definition at line 55 of file Protocol.h.