KM3NeT CLB  2.0
KM3NeT CLB v2 Embedded Software
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
slowcontrol.h
1 /**
2 @page addsc Adding slow control commands
3 
4 This document describes the steps required for adding new slow control commands to the embedded
5 software.
6 
7 There are three steps involved in adding slow control commands:
8 
9 1. Defining a new command in the configuration file
10 2. Implementing the command in the embedded software
11 3. Implementing the command in the Java API
12 
13 The first step cfg_msg.h should be modified to contain the new command. A command must have a
14 unique identifier. Commands are grouped. Each group roughly reflects the subsystems available,
15 e.g. system, network, optics, acoustics and instrumentation. In addition it also has a CLB and
16 debug set of commands. Each group may contain up to 64 commands, each having a unique identifier.
17 
18 The following code shows how the ping and date revision commands are defined in cfg_msg.h
19 @code
20 #define GROUP_SYS 0x02
21 #define MSG_SYS_PING MSG_TYPE(GROUP_SYS, 0x01)
22 #define MSG_SYS_DATEREV MSG_TYPE(GROUP_SYS, 0x02)
23 @endcode
24 
25 The MSG_TYP command combines
26  */