eip_types.h File Reference

#include <stdint.h>

Include dependency graph for eip_types.h:

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

Go to the source code of this file.

Classes
struct	EIP_CONNECTION_INFO_T
Defines
#define	EIP_PROTOCOL_VERSION   1
Typedefs
typedef bool	EIP_BOOL
typedef uint8_t	EIP_BYTE
typedef int32_t	EIP_DINT
typedef uint32_t	EIP_DWORD
typedef int16_t	EIP_INT
typedef int8_t	EIP_SINT
typedef uint32_t	EIP_UDINT
typedef uint16_t	EIP_UINT
typedef uint8_t	EIP_USINT
typedef uint16_t	EIP_WORD
Enumerations
enum	EIP_CMD_T {   EIP_CMD_NOP = 0x0000, EIP_CMD_LIST_SERVICES = 0x0004, EIP_CMD_LIST_IDENTITY = 0x0063, EIP_CMD_LIST_INTERFACES = 0x0064,   EIP_CMD_REGISTER_SESSION = 0x0065, EIP_CMD_UNREGISTER_SESSION = 0x0066, EIP_CMD_SEND_RR_DATA = 0x006F, EIP_CMD_SEND_UNIT_DATA = 0x0070,   EIP_CMD_INDICATE_STATUS = 0x0072, EIP_CMD_CANCEL = 0x0073 }
enum	EIP_ITEM_T {   EIP_ITEM_NULL = 0x0000, EIP_ITEM_LIST_IDENTITY_RESPONSE = 0x000C, EIP_ITEM_CONNECTION_BASED = 0x00A1, EIP_ITEM_CONNECTED_TRANSPORT_PACKET = 0x00B1,   EIP_ITEM_UNCONNECTED_MESSAGE = 0x00B2, EIP_ITEM_LIST_SERVICES_RESPONSE = 0x0100, EIP_ITEM_SOCKADDR_INFO_ORIGINATOR = 0x8000, EIP_ITEM_SOCKADDR_INFO_TARGET = 0x8001,   EIP_ITEM_SEQ_ADDRESS = 0x8002 }
enum	EIP_STATUS_T {   EIP_STATUS_SUCCESS = 0x0000, EIP_STATUS_INVALID_CMD = 0x0001, EIP_STATUS_OUT_OF_MEMORY = 0x0002, EIP_STATUS_INVALI_DATA = 0x0003,   EIP_STATUS_INVALID_SESSION = 0x0064, EIP_STATUS_INVALID_LENGTH = 0x0065, EIP_STATUS_INVALID_VERSION = 0x0069 }
enum	EIP_TYPE_CODE {   EIP_BOOL_CODE = 0xC1, EIP_BYTE_CODE = 0xD1, EIP_USINT_CODE = 0xC6, EIP_SINT_CODE = 0xC2,   EIP_WORD_CODE = 0xD2, EIP_UINT_CODE = 0xC7, EIP_INT_CODE = 0xC3, EIP_DWORD_CODE = 0xD3,   EIP_UDINT_CODE = 0xC8, EIP_DINT_CODE = 0xC4 }

---

Detailed Description

Software License Agreement (BSD)

Authors:

Kareem Shehata <kareem@shehata.ca>

Copyright:

Copyright (c) 2015, Clearpath Robotics, Inc., 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 Clearpath Robotics 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 WAR- RANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, IN- DIRECT, 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.

Definition in file eip_types.h.

---

Define Documentation

#define EIP_PROTOCOL_VERSION   1

Definition at line 31 of file eip_types.h.

---

Typedef Documentation

typedef bool EIP_BOOL

Definition at line 34 of file eip_types.h.

typedef uint8_t EIP_BYTE

Definition at line 35 of file eip_types.h.

typedef int32_t EIP_DINT

Definition at line 43 of file eip_types.h.

typedef uint32_t EIP_DWORD

Definition at line 41 of file eip_types.h.

typedef int16_t EIP_INT

Definition at line 40 of file eip_types.h.

typedef int8_t EIP_SINT

Definition at line 37 of file eip_types.h.

typedef uint32_t EIP_UDINT

Definition at line 42 of file eip_types.h.

typedef uint16_t EIP_UINT

Definition at line 39 of file eip_types.h.

typedef uint8_t EIP_USINT

Definition at line 36 of file eip_types.h.

typedef uint16_t EIP_WORD

Definition at line 38 of file eip_types.h.

---

Enumeration Type Documentation

enum EIP_CMD_T

Enumerator:

EIP_CMD_NOP
EIP_CMD_LIST_SERVICES
EIP_CMD_LIST_IDENTITY
EIP_CMD_LIST_INTERFACES
EIP_CMD_REGISTER_SESSION
EIP_CMD_UNREGISTER_SESSION
EIP_CMD_SEND_RR_DATA
EIP_CMD_SEND_UNIT_DATA
EIP_CMD_INDICATE_STATUS
EIP_CMD_CANCEL

Definition at line 59 of file eip_types.h.

enum EIP_ITEM_T

Enumerator:

EIP_ITEM_NULL
EIP_ITEM_LIST_IDENTITY_RESPONSE
EIP_ITEM_CONNECTION_BASED
EIP_ITEM_CONNECTED_TRANSPORT_PACKET
EIP_ITEM_UNCONNECTED_MESSAGE
EIP_ITEM_LIST_SERVICES_RESPONSE
EIP_ITEM_SOCKADDR_INFO_ORIGINATOR
EIP_ITEM_SOCKADDR_INFO_TARGET
EIP_ITEM_SEQ_ADDRESS

Definition at line 84 of file eip_types.h.

enum EIP_STATUS_T

Enumerator:

EIP_STATUS_SUCCESS
EIP_STATUS_INVALID_CMD
EIP_STATUS_OUT_OF_MEMORY
EIP_STATUS_INVALI_DATA
EIP_STATUS_INVALID_SESSION
EIP_STATUS_INVALID_LENGTH
EIP_STATUS_INVALID_VERSION

Definition at line 73 of file eip_types.h.

enum EIP_TYPE_CODE

Enumerator:

EIP_BOOL_CODE
EIP_BYTE_CODE
EIP_USINT_CODE
EIP_SINT_CODE
EIP_WORD_CODE
EIP_UINT_CODE
EIP_INT_CODE
EIP_DWORD_CODE
EIP_UDINT_CODE
EIP_DINT_CODE

Definition at line 45 of file eip_types.h.