B2B

version 1.0.0 class documentation

dday ( ACO )

Generated on 2015-12-17T15:28:17+01:00

Introduction

Explain the purpose of this class

HTML part of introduction

---

---

Interface

   [Back to top]

Device Interface

   [Back to top]

Setting Properties

   [Back to top]

Init

   [Back to top]

Control property, used to initialize the device with default values from the device instantiation file

Attributes	Value
multiplexed	false
partial-setting	true
type	setting
visibility	operational

Reset

   [Back to top]

Control property, used to reset the device while keeping the persistent data.

Attributes	Value
multiplexed	false
partial-setting	true
type	setting
visibility	operational

Setting

   [Back to top]

Used for setting hardware parameters for controlling the device.

Attributes	Value
multiplexed	true
partial-setting	true
type	setting
visibility	operational

Value-Items	Direction	Type	Scalarity	Description
mode	INOUT	B2B_MODE	custom-type-scalar
frequency	INOUT	double	scalar	Revolution frequency
frequency_max	OUT	double	scalar
frequency_min	OUT	double	scalar
convertLSAtoDDS	INOUT	bool	scalar	Convert LSA frequency values to true DDS frequency values. Set to true unless an exceptional case
harmonicNumber	INOUT	int32_t	scalar	Harmonic number at RF cavity
harmonicNumber_max	OUT	int32_t	scalar
harmonicNumber_min	OUT	int32_t	scalar
triggerOffset	INOUT	int32_t	scalar	Offset for kicker trigger, reasonable values are +/- the revolution time in the extraction ring
bucketNumber	INOUT	int32_t	scalar	EXT: extraction starts at this bucket number, required if extraction ring is larger than injection ring. INJ: injection starts at this bucket number, required if injection ring is larger than extraction ring
bucketNumber_max	OUT	int32_t	scalar
bucketNumber_min	OUT	int32_t	scalar
phaseDifference	INOUT	int32_t	scalar	Phase difference between h=1 Group DDS for injection and extraction, reasonable values are +/- the revolution time in the extraction ring
fineTune	INOUT	bool	scalar	Useful when extraction ring is larger than injection ring; enhances precision
multiBeatTune	INOUT	bool	scalar	Useful with short beating periods; enhances precision but takes more time (multiple beating periods
sidExtRing	INOUT	int32_t	scalar	Injection ring only: must match SID of extraction ring

Min-Value-Items	Direction	Type	Scalarity	Description
frequency_min	OUT	double	scalar
harmonicNumber_min	OUT	int32_t	scalar
bucketNumber_min	OUT	int32_t	scalar

Max-Value-Items	Direction	Type	Scalarity	Description
frequency_max	OUT	double	scalar
harmonicNumber_max	OUT	int32_t	scalar
bucketNumber_max	OUT	int32_t	scalar

DebugMode

   [Back to top]

Attributes	Value
multiplexed	false
partial-setting	false
type	setting
visibility	development

Value-Items	Direction	Type	Scalarity	Description
DebugMode	INOUT	bool	scalar

Power

   [Back to top]

Used to turn the power of a device on or off.

Attributes	Value
multiplexed	false
partial-setting	true
type	setting
visibility	operational

Value-Items	Direction	Type	Scalarity	Description
power	INOUT	DEVICE_POWER	custom-type-scalar

Acquisition Properties

   [Back to top]

Status

   [Back to top]

Used to display the (cycle independent) overall status of the device.Detailed status information may be additionally added to this property.

Attributes	Value
cycle-bound	false
partial-setting	false
type	acquisition
visibility	operational

Value-Items	Direction	Type	Scalarity	Description
status	OUT	DEVICE_STATUS	custom-type-scalar
detailedStatus	OUT	bool	array	Detailed status should consist of an array of boolean values considered as detailed status information as well as acorresponding string array containing keys to illustrate the meaning of the detailed status information.
detailedStatus_labels	OUT	char	array2D	Labels of detailed status bits.
detailedStatus_severity	OUT	DETAILED_STATUS_SEVERITY	custom-type-array	Severities of the detailed status bits
powerState	OUT	DEVICE_POWER_STATE	custom-type-scalar	Power state of the device (ON, OFF)
control	OUT	DEVICE_CONTROL	custom-type-scalar
interlock	OUT	bool	scalar	Interlock state of the device
opReady	OUT	bool	scalar	Contains the devices state regarding operation
modulesReady	OUT	bool	scalar	Contains the devices module state
error_codes	OUT	int32_t	array
error_messages	OUT	char	array2D
error_timestamps	OUT	int64_t	array
error_cycle_names	OUT	char	array2D

ModuleStatus

   [Back to top]

Gives detailed information on the state of 3rd party hardware and software components which are required to operate the device.

Attributes	Value
cycle-bound	false
partial-setting	false
type	acquisition
visibility	operational

Value-Items	Direction	Type	Scalarity	Description
moduleStatus	OUT	MODULE_STATUS	custom-type-array
moduleStatus_labels	OUT	char	array2D

Acquisition

   [Back to top]

Used for returning acquisition data which is retrieved from the hardware.

Attributes	Value
cycle-bound	true
partial-setting	false
type	acquisition
visibility	operational

Value-Items	Direction	Type	Scalarity	Description
state	OUT	int32_t	scalar
nBadState	OUT	int32_t	scalar
nBadStatus	OUT	int32_t	scalar
statusArray	OUT	int64_t	scalar
nTransfers	OUT	int32_t	scalar
processIndex	OUT	int32_t	scalar
sequenceIndex	OUT	int32_t	scalar
chainIndex	OUT	int32_t	scalar
eventNumber	OUT	int32_t	scalar
timingGroupID	OUT	int32_t	scalar
acquisitionStamp	OUT	int64_t	scalar
eventStamp	OUT	int64_t	scalar
processStartStamp	OUT	int64_t	scalar
sequenceStartStamp	OUT	int64_t	scalar
chainStartStamp	OUT	int64_t	scalar

Version

   [Back to top]

Returns the current software and hardware versions of a piece of equipment.

Attributes	Value
cycle-bound	false
partial-setting	false
type	acquisition
visibility	operational

Value-Items	Direction	Type	Scalarity	Description
classVersion	OUT	char	array
deployUnitVersion	OUT	char	array
fesaVersion	OUT	char	array
firmwareVersion	OUT	char	array
b2blibraryVersion	OUT	char	array

Global Interface

   [Back to top]

Setting Properties

   [Back to top]

DiagnosticSetting

   [Back to top]

Generic property which allows to diagnose any FESA classes

Attributes	Value
multiplexed	false
partial-setting	false
type	setting
visibility	expert

Value-Items	Direction	Type	Scalarity	Description
requestState	IN	bool	scalar

Acquisition Properties

   [Back to top]

DeviceDescription

   [Back to top]

Attributes	Value
cycle-bound	false
partial-setting	false
type	acquisition
visibility	operational

Value-Items	Direction	Type	Scalarity	Description
deviceNameTimingReceiver	OUT	char	array
propertyNames	OUT	char	array2D
deviceNames	OUT	char	array2D
globalDeviceName	OUT	char	array
host	OUT	char	array

Subset Interface

   [Back to top]

B2B_INJ

   [Back to top]

Properties
Init
Reset
Setting
Power
Status
ModuleStatus
Acquisition
Version

B2B_EXT

   [Back to top]

Properties
Init
Reset
Setting
Power
Status
ModuleStatus
Acquisition
Version

Data

   [Back to top]

Device Data

   [Back to top]

Configuration

   [Back to top]

Name	Type	Description
machineType	B2B_TYPE
maspEmitterEnabled	bool
detailedStatus_labels	char
detailedStatus_severity	DETAILED_STATUS_SEVERITY
moduleStatus_labels	char
subset	char

Acquisition

   [Back to top]

Name	Type	Description
firmwareVersion	int32_t
acq_state	int32_t
nBadState	int32_t
nBadStatus	int32_t
nTransfers	int32_t
statusArray	int64_t
acq_seq_ext	int32_t
acq_group_ext	int32_t
acq_mode	int32_t
acq_h1_ext	double
acq_h1_inj	double
acq_tbeat	double
control	DEVICE_CONTROL
powerState	DEVICE_POWER_STATE
status	DEVICE_STATUS
interlock	bool
opReady	bool
modulesReady	bool
detailedStatus	bool
moduleStatus	MODULE_STATUS
acquisitionContext	GSI_ACQ_CONTEXT
error_collection	GSI_ERROR

Setting

   [Back to top]

Name	Type	Description
operationMode	B2B_MODE
freq	double
convert_lsa_to_dds	bool
harmonic_number	int32_t
trigger_offset	int32_t
bucket_number	int32_t
phase	int32_t
finetune	bool
multibeattune	bool
sid_ext	int32_t
power	DEVICE_POWER

Global Data

   [Back to top]

Configuration

   [Back to top]

Name	Type	Description
deviceNameFirmware	char	Etherbone device name for firmware interface
deviceNameTimingReceiver	char

Acquisition

   [Back to top]

None

Setting

   [Back to top]

None

Custom Types

   [Back to top]

Name	Type
DIAG_TOPIC	custom-types
DEVICE_STATUS	custom-types
DEVICE_POWER_STATE	custom-types
DEVICE_POWER	custom-types
DEVICE_CONTROL	custom-types
TOL_CHECK_MODE	custom-types
AQN_STATUS	custom-types
GSI_ERROR	custom-types
GSI_ACQ_CONTEXT	custom-types
MAX_ERROR_MESSAGE_LENGTH	custom-types
MAX_NUMBER_OF_ERROR_MESSAGES	custom-types
MAX_CYCLE_NAME_LENGTH	custom-types
MAX_VERSION_NAME_LENGTH	custom-types
MAX_DETAILED_STATUS_LABEL_LENGTH	custom-types
DETAILED_STATUS_SIZE	custom-types
DETAILED_STATUS_SEVERITY	custom-types
MODULE_STATUS	custom-types
MAX_MODULE_STATUS_LABEL_LENGTH	custom-types
MODULE_STATUS_SIZE	custom-types
B2B_MODE	custom-types
B2B_TYPE	custom-types
MAX_FREQUENCY	custom-types
MIN_FREQUENCY	custom-types
MAX_HARMONIC_NUMBER	custom-types
MIN_HARMONIC_NUMBER	custom-types
MAX_BUCKET_NUMBER	custom-types
MIN_BUCKET_NUMBER	custom-types
DEVICE_NAME_LENGTH	custom-types

Struct and Enumeration Data

   [Back to top]

GSI_ERROR

   [Back to top]

Name	Scalarity	Type	Size	Description
error_string	array	char	MAX_ERROR_MESSAGE_LENGTH
error_code	scalar	int32_t
error_timestamp	scalar	int64_t
error_cycle_name	array	char	MAX_CYCLE_NAME_LENGTH

GSI_ACQ_CONTEXT

   [Back to top]

Name	Scalarity	Type	Size	Description
processIndex	scalar	int32_t		Used in order to index process-multiplexed data
sequenceIndex	scalar	int32_t		Used in order to index sequence-multiplexed data
chainIndex	scalar	int32_t		Refers to a specific beam production chain
eventNumber	scalar	int32_t		The number of the event describes it's type
timingGroupID	scalar	int32_t		ID of the timing group for which the event is relevant
acquisitionStamp	scalar	int64_t		The acquisition stamp is used to indicate when a measurement was done
eventStamp	scalar	int64_t		The event stamp is used to indicate when WhiteRabbit event was triggered on the Timing Receiver
processStartStamp	scalar	int64_t		The process start stamp indicates when the first event of the current process was triggered
sequenceStartStamp	scalar	int64_t		The sequence start stamp indicates when the first event of the current sequence was triggered
chainStartStamp	scalar	int64_t		The chain start stamp indicates when the first event of the current chain was triggered

DEVICE_STATUS

   [Back to top]

Symbol	Value	Access
UNKNOWN	0	RW
OK	1	RW
WARNING	2	RW
ERROR	3	RW

DEVICE_POWER_STATE

   [Back to top]

Symbol	Value	Access
UNKNOWN	0	RW
ON	1	RW
OFF	2	RW
STANDBY	3	RW
POWER_DOWN	4	RW
POWER_UP	5	RW

DEVICE_POWER

   [Back to top]

Symbol	Value	Access
ON	1	RW
OFF	2	RW

DEVICE_CONTROL

   [Back to top]

Symbol	Value	Access
REMOTE	0	RW
LOCAL	1	RW

TOL_CHECK_MODE

   [Back to top]

Symbol	Value	Access
ABS	0	RO
REL	1	RO

DETAILED_STATUS_SEVERITY

   [Back to top]

Symbol	Value	Access
INFO	0	RO
WARNING_ON_FALSE	1	RO
ERROR_ON_FALSE	2	RO

MODULE_STATUS

   [Back to top]

Symbol	Value	Access
UNKNOWN	0	RO
OK	1	RO
WARNING	2	RO
ERROR	3	RO
NOT_AVAILABLE	4	RO

B2B_MODE

   [Back to top]

Symbol	Value	Access
OFF	0	RW
EVT_KICK_START	1	RW
B2EXTRACTION	2	RW
B2COASTING_BEAM	3	RW
B2BUCKET	4	RW

B2B_TYPE

   [Back to top]

Symbol	Value	Access
EXT	0	RW
INJ	1	RW

AQN_STATUS

   [Back to top]

bit-enum-32bits

Bit	Name
b0	NOT_OK
b1	BAD_QUALITY
b2	DIFFERENT_FROM_SETTING
b3	OUT_OF_RANGE
b4	BUSY
b5	TIMEOUT
b6	bit6_is_reserved_for_later_usage
b7	bit7_is_reserved_for_later_usage
b8	bit8_is_reserved_for_later_usage
b9	bit9_is_reserved_for_later_usage
b10	bit10_is_reserved_for_later_usage
b11	bit11_is_reserved_for_later_usage
b12	bit12_is_reserved_for_later_usage
b13	bit13_is_reserved_for_later_usage
b14	bit14_is_reserved_for_later_usage
b15	bit15_is_reserved_for_later_usage
b16	bit_16_and_higher_can_be_used_by_the_class_developer

Constants

   [Back to top]

Name	Type	Value
MAX_ERROR_MESSAGE_LENGTH	uint32_t	256

Name	Type	Value
MAX_NUMBER_OF_ERROR_MESSAGES	uint32_t	16

Name	Type	Value
MAX_CYCLE_NAME_LENGTH	uint32_t	256

Name	Type	Value
MAX_VERSION_NAME_LENGTH	uint32_t	256

Name	Type	Value
MAX_DETAILED_STATUS_LABEL_LENGTH	uint32_t	30

Name	Type	Value
DETAILED_STATUS_SIZE	uint32_t	3

Name	Type	Value
MAX_MODULE_STATUS_LABEL_LENGTH	uint32_t	30

Name	Type	Value
MODULE_STATUS_SIZE	uint32_t	3

Name	Type	Value
MAX_FREQUENCY	double	4e6

Name	Type	Value
MIN_FREQUENCY	double	4e4

Name	Type	Value
MAX_HARMONIC_NUMBER	int32_t	255

Name	Type	Value
MIN_HARMONIC_NUMBER	int32_t	1

Name	Type	Value
MAX_BUCKET_NUMBER	int32_t	99

Name	Type	Value
MIN_BUCKET_NUMBER	int32_t	-99

Name	Type	Value
DEVICE_NAME_LENGTH	uint32_t	128