Table of Contents

1. Introduction

2. Interface

2.1. device-interface

2.1.1. setting properties

2.1.2. acquisition properties

2.2. global-interface

2.2.1. setting properties

2.2.2. acquisition properties

3.custom types

4. Scheduling-units

1. Introduction

Explain the purpose of this class

2. Interface

2.1. device-interface

2.1.1. setting properties

• Init
• multiplexed: false
• visibility: operational
• description: Control property, used to initialize the device with default values from the device instantiation file
• definition:

name	item	direction	type	description

• Reset
• multiplexed: false
• visibility: operational
• description: Control property, used to reset the device while keeping the persistent data.
• definition:

name	item	direction	type	description

• Setting
• multiplexed: false
• visibility: operational
• description: Used for setting hardware parameters for controlling the device.
• definition:

name	item	direction	type	description
Setting	voltage	INOUT	scalar: double	voltage which will used to shock a guinea pig
Setting	updateFlags	OUT
Setting	cycleName	OUT	array: char dimension: 32

• Power
• multiplexed: false
• visibility: operational
• description: Used to turn the power of a device on or off.
• definition:

name	item	direction	type	description
Power	updateFlags	OUT
Power	cycleName	OUT	array: char dimension: 32

2.1.2. acquisition properties

• Status
• multiplexed: false
• visibility: operational
• description: Used to display the (cycle independent) overall status of the device.
• definition:

name	item	direction	type	description
Status	updateFlags	OUT
Status	cycleName	OUT	array: char dimension: 32

• ModuleStatus
• multiplexed: false
• visibility: development
• description: Gives detailed information on the state of 3rd party hardware and software components which are required to operate the device.
• definition:

name	item	direction	type	description
ModuleStatus	updateFlags	OUT
ModuleStatus	cycleName	OUT	array: char dimension: 32

• Acquisition
• multiplexed: true
• visibility: operational
• description: Used for returning acquisition data which is retrieved from the hardware.
• definition:

name	item	direction	type	description
Acquisition	voltage	OUT	scalar: double	The voltage which was measured on the device
	voltageSet	OUT	scalar: double	set-value which was applied to the device during measurement
Acquisition	updateFlags	OUT
Acquisition	cycleName	OUT	array: char dimension: 32

• Version
• multiplexed: false
• visibility: operational
• description: Returns the current software and hardware versions of a piece of equipment.
• definition:

name	item	direction	type	description
Version	updateFlags	OUT
Version	cycleName	OUT	array: char dimension: 32

2.2. global-interface

2.2.1. setting properties

• DiagnosticSetting
• multiplexed: false
• visibility: expert
• description: Generic property which allows to diagnose any FESA classes
• definition:

name	item	direction	type	description
DiagnosticSetting	enableDiagMode	INOUT	scalar: bool
DiagnosticSetting	hostName	INOUT	array: char dimension: 32	Host of the FESA class
DiagnosticSetting	portNumber	INOUT	scalar: int32_t	Port used by the FESA class
DiagnosticSetting	requestConfig	IN	scalar: bool
DiagnosticSetting	requestState	IN	scalar: bool
DiagnosticSetting	fwkTopic	INOUT
DiagnosticSetting	customTopic	INOUT	scalar: DIAG_TOPIC
DiagnosticSetting	traceDevices	INOUT	array: char dimension: 320
DiagnosticSetting	bypassActions	INOUT	array: char dimension: 320

2.2.2. acquisition properties

• DeviceDescription
• multiplexed: false
• visibility: operational
• description:
• definition:

name	item	direction	type	description

3. custom types

• DIAG_TOPIC

name	description	elements
DIAG_TOPIC

• DEVICE_STATUS

name	description	elements
DEVICE_STATUS		item:   access=RW,  meaning=NONE,  symbol=UNKNOWN,  value=0,  id=_160407142132_3,  ;  item:   access=RW,  meaning=NONE,  symbol=OK,  value=1,  id=_160407142132_4,  ;  item:   access=RW,  meaning=NONE,  symbol=WARNING,  value=2,  id=_160407142132_5,  ;  item:   access=RW,  meaning=NONE,  symbol=ERROR,  value=3,  id=_160407142132_6,  ;

• DEVICE_POWER_STATE

name	description	elements
DEVICE_POWER_STATE		item:   access=RW,  meaning=NONE,  symbol=UNKNOWN,  value=0,  id=_160407142132_7,  ;  item:   access=RW,  meaning=ON,  symbol=ON,  value=1,  id=_160407142132_8,  ;  item:   access=RW,  meaning=NONE,  symbol=OFF,  value=2,  id=_160407142132_9,  ;  item:   access=RW,  meaning=NONE,  symbol=STANDBY,  value=3,  id=_160407142132_10,  ;  item:   access=RW,  meaning=NONE,  symbol=POWER_DOWN,  value=4,  id=_160407142132_11,  ;  item:   access=RW,  meaning=NONE,  symbol=POWER_UP,  value=5,  id=_160407142132_12,  ;

• DEVICE_POWER

name	description	elements
DEVICE_POWER		item:   access=RW,  meaning=ON,  symbol=ON,  value=1,  id=_160407142133_0,  ;  item:   access=RW,  meaning=OFF,  symbol=OFF,  value=2,  id=_160407142133_1,  ;

• DEVICE_CONTROL

name	description	elements
DEVICE_CONTROL		item:   access=RW,  meaning=NONE,  symbol=REMOTE,  value=0,  id=_160407142133_2,  ;  item:   access=RW,  meaning=NONE,  symbol=LOCAL,  value=1,  id=_160407142133_3,  ;

• TOL_CHECK_MODE

name	description	elements
TOL_CHECK_MODE		item:   access=RO,  symbol=ABS,  value=0,  id=_160407142133_4,  ;  item:   access=RO,  symbol=REL,  value=1,  id=_160407142133_5,  ;

• AQN_STATUS

name	description	elements
AQN_STATUS		b0: NOT_OK  ;  b1: NOT_OK  ;  b2: NOT_OK  ;  b3: NOT_OK  ;  b4: NOT_OK  ;  b5: NOT_OK  ;  b6: NOT_OK  ;  b7: NOT_OK  ;  b8: NOT_OK  ;  b9: NOT_OK  ;  b10: NOT_OK  ;  b11: NOT_OK  ;  b12: NOT_OK  ;  b13: NOT_OK  ;  b14: NOT_OK  ;  b15: NOT_OK  ;  b16: NOT_OK  ;

• GSI_ERROR

name	description	elements
GSI_ERROR		struct-item: error_string  id=_160407142134_0,  ;  struct-item: error_string  id=_160407142134_1,  ;  struct-item: error_string  id=_160407142134_2,  ;  struct-item: error_string  id=_160407142134_3,  ;

• GSI_ACQ_CONTEXT

name	description	elements
GSI_ACQ_CONTEXT	WhiteRabbit event specific acquisition information	struct-item: processIndex  id=_160407142134_4,  ;  struct-item: processIndex  id=_160407142134_5,  ;  struct-item: processIndex  id=_160407142134_6,  ;  struct-item: processIndex  id=_160407142134_7,  ;  struct-item: processIndex  id=_160407142134_8,  ;  struct-item: processIndex  id=_160407142134_9,  ;  struct-item: processIndex  id=_160407142134_10,  ;  struct-item: processIndex  id=_160407142134_11,  ;  struct-item: processIndex  id=_160407142134_12,  ;  struct-item: processIndex  id=_160407142134_13,  ;

• MAX_ERROR_MESSAGE_LENGTH

name	description	elements
MAX_ERROR_MESSAGE_LENGTH

• MAX_NUMBER_OF_ERROR_MESSAGES

name	description	elements
MAX_NUMBER_OF_ERROR_MESSAGES

• MAX_CYCLE_NAME_LENGTH

name	description	elements
MAX_CYCLE_NAME_LENGTH

• MAX_VERSION_NAME_LENGTH

name	description	elements
MAX_VERSION_NAME_LENGTH

• MAX_DETAILED_STATUS_LABEL_LENGTH

name	description	elements
MAX_DETAILED_STATUS_LABEL_LENGTH

• DETAILED_STATUS_SIZE

name	description	elements
DETAILED_STATUS_SIZE

• DETAILED_STATUS_SEVERITY

name	description	elements
DETAILED_STATUS_SEVERITY		item:   access=RO,  symbol=INFO,  value=0,  id=_160407142133_6,  ;  item:   access=RO,  symbol=WARNING_ON_FALSE,  value=1,  id=_160407142133_7,  ;  item:   access=RO,  symbol=ERROR_ON_FALSE,  value=2,  id=_160407142133_8,  ;

• MODULE_STATUS

name	description	elements
MODULE_STATUS		item:   access=RO,  symbol=UNKNOWN,  value=0,  id=_160407142133_9,  ;  item:   access=RO,  symbol=OK,  value=1,  id=_160407142133_10,  ;  item:   access=RO,  symbol=WARNING,  value=2,  id=_160407142133_11,  ;  item:   access=RO,  symbol=ERROR,  value=3,  id=_160407142133_12,  ;  item:   access=RO,  symbol=NOT_AVAILABLE,  value=4,  id=_160407142133_13,  ;

• MAX_MODULE_STATUS_LABEL_LENGTH

name	description	elements
MAX_MODULE_STATUS_LABEL_LENGTH

• MODULE_STATUS_SIZE

name	description	elements
MODULE_STATUS_SIZE

4. Scheduling-units