Midas C++ API - MSCB

int host2ip(const char *hostname, char *ip, int size)

Declared in mscb/include/mscb.h:446, defined in mscb/src/mscb.cxx:432

int kbhit()

Declared in mscb/include/mscb.h:457, defined in mscb/src/mscb.cxx:257

int mscb_addr(int fd, int cmd, unsigned short adr, int quick, int retry)

Address node or nodes, only used internall from read and write routines. A MSCB lock has to be obtained outside of this routine!

Parameters:

• fd (int) [in] –
  File descriptor for connection
• cmd (int) [in] –
  Addressing mode, one of
  MCMD_ADDR_BC
  MCMD_ADDR_NODE8
  MCMD_ADDR_GRP8
  MCMD_PING8
  MCMD_ADDR_NODE16
  MCMD_ADDR_GRP16
  MCMD_PING16
• adr (unsigned short) [in] –
  Node or group address
• quick (int) [in] –
  Quick ping (short timeout)
• retry (int) [in] –
  Number of retries

Returns:

• MSCB_SUCCESS –
  Successful completion
• MSCB_TIMEOUT –
  Timeout receiving ping acknowledge
• MSCB_MUTEX –
  Cannot obtain mutex for mscb

Declared in mscb/include/mscb.h:436, defined in mscb/src/mscb.cxx:1274

void mscb_check(char *device, int size)

Defined in mscb/include/mscb.h:396

int mscb_clear_log(int fd, unsigned short adr)

Clears the log on the addressed node

Parameters:

• fd (int) [in] –
  File descriptor for connection
• adr (unsigned short) [in] –
  Node address

Returns:

• MSCB_SUCCESS –
  Successful completion
• MSCB_TIMEOUT –
  Timeout receiving data
• MSCB_CRC_ERROR –
  CRC error
• MSCB_MUTEX –
  Cannot obtain mutex for mscb
• MSCB_INVAL_PARAM –
  Invalid parameters

Declared in mscb/include/mscb.h:443, defined in mscb/src/mscb.cxx:5257

int mscb_debug(int flag)

set global debug flag

Declared in mscb/include/mscb.h:392, defined in mscb/src/mscb.cxx:1237

int mscb_download(int fd, unsigned short node_adr, short sub_adr, const char *filename)

Download firmware from node to file

Parameters:

• fd (int) [in] –
  File descriptor for connection
• node_adr (unsigned short)
• sub_adr (short) [in] –
  Subaddress of WaveDAQ crate (slot)
• filename (const char *) [in] –
  Filename
• adr [in] –
  Node address

Returns:

• MSCB_SUCCESS –
  Successful completion
• MSCB_TIMEOUT –
  Timeout receiving acknowledge
• MSCB_CRC_ERROR –
  CRC error
• MSCB_INVAL_PARAM –
  Parameter "size" has invalid value
• MSCB_MUTEX –
  Cannot obtain mutex for mscb
• MSCB_NOT_FOUND –
  File 'filename' exists alread

Declared in mscb/include/mscb.h:423, defined in mscb/src/mscb.cxx:3328

int mscb_echo(int fd, unsigned short add, unsigned char d1, unsigned char *d2)

Send byte and receive echo, useful for testing

Parameters:

• fd (int) [in] –
  File descriptor for connection
• add (unsigned short) [in] –
  Node address
• d1 (unsigned char) [in] –
  Byte to send
• d2 (unsigned char *) [out] –
  Received byte

Returns:

• MSCB_SUCCESS –
  Successful completion
• MSCB_TIMEOUT –
  Timeout receiving data
• MSCB_CRC_ERROR –
  CRC error
• MSCB_MUTEX –
  Cannot obtain mutex for mscb
• MSCB_FORMAT_ERROR –
  "size" parameter too large

Declared in mscb/include/mscb.h:401, defined in mscb/src/mscb.cxx:4770

int mscb_exit(int fd)

Close a MSCB interface

Parameters:

• fd (int) [in] –
  file descriptor for connection

Returns:

• MSCB_SUCCESS –
  Successful completion

Declared in mscb/include/mscb.h:397, defined in mscb/src/mscb.cxx:1209

int mscb_flash(int fd, int adr, int gaddr, int broadcast)

Flash node variables to EEPROM

Parameters:

• fd (int) [in] –
  File descriptor for connection
• adr (int) [in] –
  Node address
• gaddr (int) [in] –
  Group address
• broadcast (int) [in] –
  Broadcast flag

Returns:

• MSCB_SUCCESS –
  Successful completion
• MSCB_TIMEOUT –
  Timeout receiving acknowledge
• MSCB_CRC_ERROR –
  CRC error
• MSCB_INVAL_PARAM –
  Parameter "size" has invalid value
• MSCB_MUTEX –
  Cannot obtain mutex for mscb

Declared in mscb/include/mscb.h:412, defined in mscb/src/mscb.cxx:2398

void mscb_get_device(int fd, char *device, int bufsize)

Return device name for fd

Parameters:

• fd (int) [in] –
  File descriptor obtained via mscb_init()
• device (char *) [in] –
  device name, "" if invalid fd
• bufsize (int) [in] –
  Size of device string

Declared in mscb/include/mscb.h:394, defined in mscb/src/mscb.cxx:1247

int mscb_get_eth_max_retry(int fd)

Get the current setting of the MSCB ethernet retry limit

Parameters:

• fd (int) [in] –
  file descriptor for mscb connection
• value [in] –
  current value of the MSCB ethernet retry limit

Declared in mscb/include/mscb.h:418, defined in mscb/src/mscb.cxx:510

unsigned int mscb_get_eth_pause(int fd)

Get the current pause time of the MSCB ethernet communication

Parameters:

• fd (int) [in] –
  file descriptor for mscb connection
• value [in] –
  current value of the MSCB paus time in ms

Declared in mscb/include/mscb.h:420, defined in mscb/src/mscb.cxx:557

int mscb_get_max_retry()

Get the current setting of the MSCB maximum retry limit

Return value:
  current value of the MSCB maximum retry limit

Declared in mscb/include/mscb.h:414, defined in mscb/src/mscb.cxx:475

int mscb_get_usb_timeout()

Defined in mscb/include/mscb.h:416

void mscb_get_version(char *lib_version, int lib_size, char *prot_version, int prot_size)

Declared in mscb/include/mscb.h:395, defined in mscb/src/mscb.cxx:991

int mscb_info(int fd, unsigned short adr, MSCB_INFO * info)

Retrieve info on addressd node

Parameters:

• fd (int) [in] –
  File descriptor for connection
• adr (unsigned short) [in] –
  Node address
• info (MSCB_INFO *) [out] –
  Info structure defined in mscb.h

Returns:

• MSCB_SUCCESS –
  Successful completion
• MSCB_TIMEOUT –
  Timeout receiving data
• MSCB_CRC_ERROR –
  CRC error
• MSCB_MUTEX –
  Cannot obtain mutex for mscb

Declared in mscb/include/mscb.h:402, defined in mscb/src/mscb.cxx:1532

int mscb_info_variable(int fd, unsigned short adr, unsigned char index, MSCB_INFO_VAR * info)

Retrieve info on a specific node variable

Parameters:

• fd (int) [in] –
  File descriptor for connection
• adr (unsigned short) [in] –
  Node address
• index (unsigned char) [in] –
  Variable index 0..255
• info (MSCB_INFO_VAR *) [out] –
  Info structure defined in mscb.h

Returns:

• MSCB_SUCCESS –
  Successful completion
• MSCB_TIMEOUT –
  Timeout receiving data
• MSCB_CRC_ERROR –
  CRC error
• MSCB_MUTEX –
  Cannot obtain mutex for mscb

Declared in mscb/include/mscb.h:403, defined in mscb/src/mscb.cxx:1685

int mscb_init(char *device, int device_size, const char *password, int debug)

Initialize and open MSCB

Parameters:

• device (char *) [in] –
  mscbxxx for Ethernet connection
• device_size (int) [in] –
  Size of "device" string, in case no device is specified from the caller and this function returns the chosen device
• password (const char *) [in] –
  Optional password, used for ethernet submasters
• debug (int) [in] –
  Debug flag:
  1: all writes are logged to mscb_write.log
  2: all writes and read are logged to mscb_debug.log
  3: debug output is written to screen

Returns:

• int –
  int fd: device descriptor for connection, negative number in case of error:
• EMSCB_NO_MEM –
  Out of memory for file descriptors
• EMSCB_RPC_ERROR –
  Cannot talk to Ethernet submaster
• EMSCB_COMM_ERROR –
  Submaster does not reply on echo
• EMSCB_LOCKED –
  MSCB system locked by other user
• EMSCB_NO_ACCESS –
  No access to submaster
• EMSCB_INVAL_PARAM –
  Invalid parameter
• EMSCB_NOT_FOUND –
  Submaster not found
• EMSCB_NO_WRITE_ACCESS –
  No write access under linux
• EMSCB_WRONG_PASSWORD –
  Wrong password
• EMSCB_SUMB_VERSION –
  Submaster has wrong protocol version

Declared in mscb/include/mscb.h:391, defined in mscb/src/mscb.cxx:998

int mscb_legacy_verify(int fd, unsigned short adr, unsigned char *buffer)

Compare remote firmware with buffer contents

Parameters:

• fd (int) [in] –
  File descriptor for connection
• adr (unsigned short) [in] –
  Node address
• buffer (unsigned char *) [in] –
  Buffer with Intel HEX file
• size [in] –
  Size of buffer

Returns:

• MSCB_SUCCESS –
  Successful completion
• MSCB_TIMEOUT –
  Timeout receiving acknowledge
• MSCB_CRC_ERROR –
  CRC error
• MSCB_INVAL_PARAM –
  Parameter "size" has invalid value
• MSCB_MUTEX –
  Cannot obtain mutex for mscb
• MSCB_FORMAT_ERROR –
  Error in HEX file format

Declared in mscb/include/mscb.h:425, defined in mscb/src/mscb.cxx:3908

int mscb_link(int fd, unsigned short adr, unsigned char index, void *data, int size)

Used by LabView to link controls to MSCB variables

Parameters:

• fd (int) [in] –
  File descriptor for connection
• adr (unsigned short) [in] –
  Node address
• index (unsigned char) [in] –
  Variable index
• data (void *) [in,out] –
  Pointer to data
  Readback data
• size (int) [in] –
  Size of data

Returns:

• MSCB_SUCCESS –
  Successful completion
• MSCB_TIMEOUT –
  Timeout receiving data
• MSCB_CRC_ERROR –
  CRC error
• MSCB_MUTEX –
  Cannot obtain mutex for mscb
• MSCB_FORMAT_ERROR –
  "size" parameter too large
• MSCB_NO_MEM –
  Out of memory

Declared in mscb/include/mscb.h:435, defined in mscb/src/mscb.cxx:4831

int mscb_ping(int fd, unsigned short adr, int quick, int retry)

Ping node to see if it's alive

Parameters:

• fd (int) [in] –
  File descriptor for connection
• adr (unsigned short) [in] –
  Node address
• quick (int) [in] –
  If 1, do a quick ping (short timeout)
• retry (int) [in] –
  If 1, retry if no response (slow)

Returns:

• MSCB_SUCCESS –
  Successful completion
• MSCB_TIMEOUT –
  Timeout receiving data
• MSCB_MUTEX –
  Cannot obtain mutex for mscb

Declared in mscb/include/mscb.h:400, defined in mscb/src/mscb.cxx:1485

int mscb_read(int fd, unsigned short adr, unsigned char index, void *data, int *size)

Read data from variable on node

Parameters:

• fd (int) [in] –
  File descriptor for connection
• adr (unsigned short) [in] –
  Node address
• index (unsigned char) [in] –
  Variable index 0..255
• data (void *) [out] –
  Received data
• size (int *) [in,out] –
  Buffer size for data
  Number of received bytes

Returns:

• MSCB_SUCCESS –
  Successful completion
• MSCB_TIMEOUT –
  Timeout receiving acknowledge
• MSCB_CRC_ERROR –
  CRC error
• MSCB_INVAL_PARAM –
  Parameter "size" has invalid value
• MSCB_MUTEX –
  Cannot obtain mutex for mscb
• MSCB_INVALID_INDEX –
  index parameter too large

Declared in mscb/include/mscb.h:426, defined in mscb/src/mscb.cxx:4067

int mscb_read_log(int fd, unsigned short adr, void* dataBuf, int bufsize)

Reads the log from the addressed node

Parameters:

• fd (int) [in] –
  File descriptor for connection
• adr (unsigned short) [in] –
  Node address
• dataBuf (void*) [out] –
  log data
• bufsize (int) [out] –
  buffersize

Returns:

• MSCB_SUCCESS –
  Successful completion
• MSCB_TIMEOUT –
  Timeout receiving data
• MSCB_CRC_ERROR –
  CRC error
• MSCB_MUTEX –
  Cannot obtain mutex for mscb
• MSCB_INVAL_PARAM –
  Invalid parameters

Declared in mscb/include/mscb.h:444, defined in mscb/src/mscb.cxx:5315

int mscb_read_mem(int fd, unsigned short node_adr, int sub_adr, unsigned int mem_adr, void *buffer, int size)

Read block of data to memory

Parameters:

• fd (int) [in] –
  File descriptor for connection
• node_adr (unsigned short)
• sub_adr (int) [in] –
  Slot number
• mem_adr (unsigned int) [in] –
  Memory address
• buffer (void *) [in] –
  Data buffer
• size (int) [in] –
  Number of bytes to read
• address [in]

Returns:

• MSCB_INVAL_PARAM –
  Invalid parameter
• MSCB_SUCCESS –
  Successful completion
• MSCB_TIMEOUT –
  Timeout
• MSCB_CRC_ERROR –
  CRC error
• MSCB_MUTEX –
  Cannot obtain mutex for mscb

Declared in mscb/include/mscb.h:432, defined in mscb/src/mscb.cxx:4620

int mscb_read_no_retries(int fd, unsigned short adr, unsigned char index, void *data, int *size)

Same as mscb_read, but without retries

Parameters:

• fd (int) [in] –
  File descriptor for connection
• adr (unsigned short) [in] –
  Node address
• index (unsigned char) [in] –
  Variable index 0..255
• data (void *) [out] –
  Received data
• size (int *) [in,out] –
  Buffer size for data
  Number of received bytes

Returns:

• MSCB_SUCCESS –
  Successful completion
• MSCB_TIMEOUT –
  Timeout receiving acknowledge
• MSCB_CRC_ERROR –
  CRC error
• MSCB_INVAL_PARAM –
  Parameter "size" has invalid value
• MSCB_MUTEX –
  Cannot obtain mutex for mscb

Declared in mscb/include/mscb.h:427, defined in mscb/src/mscb.cxx:4240

int mscb_read_range(int fd, unsigned short adr, unsigned char index1, unsigned char index2, void *data, int *size)

Read data from multiple channels on node

Parameters:

• fd (int) [in] –
  File descriptor for connection
• adr (unsigned short) [in] –
  Node address
• index1 (unsigned char) [in] –
  First index to read
• index2 (unsigned char) [in] –
  Last index to read
• data (void *) [out] –
  Received data
• size (int *) [in,out] –
  Buffer size for data
  Number of received bytes

Returns:

• MSCB_SUCCESS –
  Successful completion
• MSCB_TIMEOUT –
  Timeout receiving acknowledge
• MSCB_CRC_ERROR –
  CRC error
• MSCB_INVAL_PARAM –
  Parameter "size" has invalid value
• MSCB_MUTEX –
  Cannot obtain mutex for mscb

Declared in mscb/include/mscb.h:428, defined in mscb/src/mscb.cxx:4370

int mscb_reboot(int fd, int addr, int gaddr, int broadcast)

Reboot node by sending MCMD_INIT

Parameters:

• fd (int) [in] –
  File descriptor for connection
• addr (int) [in] –
  Node address
• gaddr (int) [in] –
  Group address
• broadcast (int) [in] –
  Broadcast flag

Returns:

• MSCB_SUCCESS –
  Successful completion
• MSCB_MUTEX –
  Cannot obtain mutex for mscb
• MSCB_TIMEOUT –
  Timeout receiving ping acknowledge

Declared in mscb/include/mscb.h:399, defined in mscb/src/mscb.cxx:1367

void mscb_scan_udp()

Scan network for running ethernet submasters

Declared in mscb/include/mscb.h:440, defined in mscb/src/mscb.cxx:5049

int mscb_select_device(char *data, int size, int select)

Defined in mscb/include/mscb.h:393

int mscb_set_baud(int fd, int baud)

Set baud rate of a whole MSCB bus

Parameters:

• fd (int) [in] –
  File descriptor for connection
• baud (int) [in] –
  Baud rate:
  1: 2400
  2: 4800
  3: 9600
  4: 19200
  5: 28800
  6: 38400
  7: 57600
  8: 115200
  9: 172800 10: 345600

Returns:

• MSCB_SUCCESS –
  Successful completion
• MSCB_TIMEOUT –
  Timeout receiving acknowledge
• MSCB_CRC_ERROR –
  CRC error
• MSCB_INVAL_PARAM –
  Parameter "size" has invalid value
• MSCB_MUTEX –
  Cannot obtain mutex for mscb

Declared in mscb/include/mscb.h:413, defined in mscb/src/mscb.cxx:2463

int mscb_set_eth_max_retry(int fd, int eth_max_retry)

Set retry limit for MSCB ethernet communications

Parameters:

• fd (int) [in] –
  file descriptor for mscb connection
• eth_max_retry (int) [in] –
  new value for ethernet retry limit

Returns:

• int –
  old value of the ethernet maximum retry limit

Declared in mscb/include/mscb.h:419, defined in mscb/src/mscb.cxx:531

int mscb_set_eth_pause(int fd, unsigned int pause)

Get the current pause time of the MSCB ethernet communication

Parameters:

• fd (int) [in] –
  file descriptor for mscb connection
• pause (unsigned int)
• eth_max_retry [in] –
  new value in ms

Returns:

• MSCB_SUCCESS –
  Successful completion

Declared in mscb/include/mscb.h:421, defined in mscb/src/mscb.cxx:578

int mscb_set_group_addr(int fd, int addr, int gaddr, int broadcast, unsigned short new_addr)

Set group address of addressed node(s)

Parameters:

• fd (int) [in] –
  File descriptor for connection
• addr (int) [in] –
  Node address
• gaddr (int) [in] –
  Group address
• broadcast (int) [in] –
  Broadcast flag
• new_addr (unsigned short)
• address [in]

Returns:

• MSCB_SUCCESS –
  Successful completion
• MSCB_MUTEX –
  Cannot obtain mutex for mscb

Declared in mscb/include/mscb.h:406, defined in mscb/src/mscb.cxx:1871

int mscb_set_max_retry(int max_retry)

Set the limit for retrying MSCB operations

Parameters:

• max_retry (int) [in] –
  new value of the mscb maximum retry limit

Returns:

• int –
  old value of the maximum retry limit

Declared in mscb/include/mscb.h:415, defined in mscb/src/mscb.cxx:490

int mscb_set_name(int fd, unsigned short adr, char *name)

Set node name

Parameters:

• fd (int) [in] –
  File descriptor for connection
• adr (unsigned short) [in] –
  Node address
• name (char *) [in] –
  New node name, up to 16 characters

Returns:

• MSCB_SUCCESS –
  Successful completion
• MSCB_MUTEX –
  Cannot obtain mutex for mscb

Declared in mscb/include/mscb.h:407, defined in mscb/src/mscb.cxx:1943

int mscb_set_node_addr(int fd, int addr, int gaddr, int broadcast, unsigned short new_addr)

Set node address of an node. Only set high byte if addressed in group or broadcast mode

Parameters:

• fd (int) [in] –
  File descriptor for connection
• addr (int) [in] –
  Node address
• gaddr (int) [in] –
  Group address
• broadcast (int) [in] –
  Broadcast flag
• new_addr (unsigned short)
• address [in]

Returns:

• MSCB_SUCCESS –
  Successful completion
• MSCB_MUTEX –
  Cannot obtain mutex for mscb

Declared in mscb/include/mscb.h:405, defined in mscb/src/mscb.cxx:1788

int mscb_set_time(int fd, int addr, int gaddr, int broadcast)

Set time of node equal to local time

Parameters:

• fd (int) [in] –
  File descriptor for connection
• addr (int) [in] –
  Node address
• gaddr (int) [in] –
  Group address
• broadcast (int) [in] –
  Broadcast flag

Returns:

• MSCB_SUCCESS –
  Successful completion
• MSCB_MUTEX –
  Cannot obtain mutex for mscb
• MSCB_TIMEOUT –
  Timeout receiving ping acknowledge

Declared in mscb/include/mscb.h:437, defined in mscb/src/mscb.cxx:5178

int mscb_set_usb_timeout(int timeout)

Defined in mscb/include/mscb.h:417

int mscb_subm_info(int fd)

Show info for submaster

Declared in mscb/include/mscb.h:441, defined in mscb/src/mscb.cxx:5127

int mscb_subm_reset(int fd)

Reset submaster via hardware reset

Parameters:

• fd (int) [in] –
  File descriptor for connection

Returns:

• MSCB_SUCCESS –
  Successful completion
• MSCB_SEMPHORE –
  Cannot obtain semaphore for mscb

Declared in mscb/include/mscb.h:398, defined in mscb/src/mscb.cxx:1429

int mscb_upload(int fd, unsigned short adr, short int sub_adr, const char *filename, int flags)

Upload new firmware to node

Parameters:

• fd (int) [in] –
  File descriptor for connection
• adr (unsigned short) [in] –
  Node address
• sub_adr (short int) [in] –
  Subaddress of WaveDAQ crate (slot)
• filename (const char *)
• flags (int) [in] –
  MSCB_UPLOAD_DEBUG: produce detailed debugging output MSCB_UPLOAD_VERIFY: only verify image MSCB_UPLOAD_SUBADDR: upload using subaddress
• buffer [in] –
  Buffer with Intel HEX file

Returns:

• MSCB_SUCCESS –
  Successful completion
• MSCB_TIMEOUT –
  Timeout receiving acknowledge
• MSCB_CRC_ERROR –
  CRC error
• MSCB_INVAL_PARAM –
  Parameter "size" has invalid value
• MSCB_MUTEX –
  Cannot obtain mutex for mscb
• MSCB_FORMAT_ERROR –
  Error in HEX file format
• MSCB_NOT_FOUND –
  File 'filename' not found

Declared in mscb/include/mscb.h:422, defined in mscb/src/mscb.cxx:3037

int mscb_uptime(int fd, unsigned short adr, unsigned int *uptime)

Retrieve uptime of node in seconds

Parameters:

• fd (int) [in] –
  File descriptor for connection
• adr (unsigned short) [in] –
  Node address
• uptime (unsigned int *) [out] –
  Uptime in seconds

Returns:

• MSCB_SUCCESS –
  Successful completion
• MSCB_TIMEOUT –
  Timeout receiving data
• MSCB_CRC_ERROR –
  CRC error
• MSCB_MUTEX –
  Cannot obtain mutex for mscb

Declared in mscb/include/mscb.h:404, defined in mscb/src/mscb.cxx:1629

int mscb_user(int fd, unsigned short adr, void *param, int size, void *result, int *rsize)

Call user function on node

Parameters:

• fd (int) [in] –
  File descriptor for connection
• adr (unsigned short) [in] –
  Node address
• param (void *) [in] –
  Parameters passed to user function, no CRC code
• size (int) [in] –
  Size of parameters in bytes
• result (void *) [out] –
  Optional return parameters
• rsize (int *) [in,out] –
  Size of result buffer
  Number of returned size

Returns:

• MSCB_SUCCESS –
  Successful completion
• MSCB_TIMEOUT –
  Timeout receiving data
• MSCB_CRC_ERROR –
  CRC error
• MSCB_MUTEX –
  Cannot obtain mutex for mscb
• MSCB_FORMAT_ERROR –
  "size" parameter too large

Declared in mscb/include/mscb.h:434, defined in mscb/src/mscb.cxx:4693

int mscb_verify(int fd, unsigned short adr, short int sub_adr, const char *filename, int flags)

Verify firmware on node

Parameters:

• fd (int) [in] –
  File descriptor for connection
• adr (unsigned short) [in] –
  Node address
• sub_adr (short int) [in] –
  Subaddress of WaveDAQ crate (slot)
• filename (const char *)
• flags (int) [in] –
  MSCB_UPLOAD_DEBUG: produce detailed debugging output
  MSCB_UPLOAD_VERIFY: only verify image
  MSCB_UPLOAD_SUBADDR: upload using subaddress
• buffer [in] –
  Buffer with Intel HEX file

Returns:

• MSCB_SUCCESS –
  Successful completion
• MSCB_TIMEOUT –
  Timeout receiving acknowledge
• MSCB_CRC_ERROR –
  CRC error
• MSCB_INVAL_PARAM –
  Parameter "size" has invalid value
• MSCB_MUTEX –
  Cannot obtain mutex for mscb
• MSCB_FORMAT_ERROR –
  Error in HEX file format
• MSCB_NOT_FOUND –
  File 'filename' not found

Declared in mscb/include/mscb.h:424, defined in mscb/src/mscb.cxx:3595

int mscb_write(int fd, unsigned short adr, unsigned char index, void *data, int size)

Write data to variable on single node

Parameters:

• fd (int) [in] –
  File descriptor for connection
• adr (unsigned short) [in] –
  Node address
• index (unsigned char) [in] –
  Variable index 0..255
• data (void *) [in] –
  Data to send
• size (int) [in] –
  Data size in bytes 1..4 for byte, word, and dword

Returns:

• MSCB_SUCCESS –
  Successful completion
• MSCB_TIMEOUT –
  Timeout receiving acknowledge
• MSCB_CRC_ERROR –
  CRC error
• MSCB_INVAL_PARAM –
  Parameter "size" has invalid value
• MSCB_MUTEX –
  Cannot obtain mutex for mscb

Declared in mscb/include/mscb.h:408, defined in mscb/src/mscb.cxx:2043

int mscb_write_group(int fd, unsigned short adr, unsigned char index, void *data, int size)

Write data to channels on group of nodes

Parameters:

• fd (int) [in] –
  File descriptor for connection
• adr (unsigned short) [in] –
  group address
• index (unsigned char) [in] –
  Variable index 0..255
• data (void *) [in] –
  Data to send
• size (int) [in] –
  Data size in bytes 1..4 for byte, word, and dword

Returns:

• MSCB_SUCCESS –
  Successful completion
• MSCB_MUTEX –
  Cannot obtain mutex for mscb

Declared in mscb/include/mscb.h:410, defined in mscb/src/mscb.cxx:1992

int mscb_write_mem(int fd, unsigned short node_adr, int sub_adr, unsigned int mem_adr, void *buffer, int size)

Write block of data to memory

Parameters:

• fd (int) [in] –
  File descriptor for connection
• node_adr (unsigned short)
• sub_adr (int) [in] –
  Slot number
• mem_adr (unsigned int) [in] –
  Memory address
• buffer (void *) [in] –
  Data buffer
• size (int) [in] –
  Number of bytes in buffer
• address [in]

Returns:

• MSCB_INVAL_PARAM –
  Invalid parameter
• MSCB_SUCCESS –
  Successful completion
• MSCB_TIMEOUT –
  Timeout
• MSCB_CRC_ERROR –
  CRC error
• MSCB_MUTEX –
  Cannot obtain mutex for mscb

Declared in mscb/include/mscb.h:430, defined in mscb/src/mscb.cxx:4548

int mscb_write_no_retries(int fd, unsigned short adr, unsigned char index, void *data, int size)

Same as mscb_write, but without retries

Parameters:

• fd (int) [in] –
  File descriptor for connection
• adr (unsigned short) [in] –
  Node address
• index (unsigned char) [in] –
  Variable index 0..255
• data (void *) [in] –
  Data to send
• size (int) [in] –
  Data size in bytes 1..4 for byte, word, and dword

Returns:

• MSCB_SUCCESS –
  Successful completion
• MSCB_TIMEOUT –
  Timeout receiving acknowledge
• MSCB_CRC_ERROR –
  CRC error
• MSCB_INVAL_PARAM –
  Parameter "size" has invalid value
• MSCB_MUTEX –
  Cannot obtain mutex for mscb

Declared in mscb/include/mscb.h:409, defined in mscb/src/mscb.cxx:2181

int mscb_write_range(int fd, unsigned short adr, unsigned char index1, unsigned char index2, void *data, int size)

Write data to multiple indices on node

Parameters:

• fd (int) [in] –
  File descriptor for connection
• adr (unsigned short) [in] –
  Node address
• index1 (unsigned char) [in] –
  First variable index 0..255 to write
• index2 (unsigned char) [in] –
  Last variable index 0..255 to write
• data (void *) [in] –
  Data to send
• size (int) [in] –
  Data size in bytes

Returns:

• MSCB_SUCCESS –
  Successful completion
• MSCB_TIMEOUT –
  Timeout receiving acknowledge
• MSCB_CRC_ERROR –
  CRC error
• MSCB_INVAL_PARAM –
  Parameter "size" has invalid value
• MSCB_MUTEX –
  Cannot obtain mutex for mscb

Declared in mscb/include/mscb.h:411, defined in mscb/src/mscb.cxx:2285

int set_mac_address(int fd)

Ask for hostname/password and set MAC configuration of subm_260 interface over ethernet

Parameters:

• fd (int) [in] –
  File descriptor for connection
• interactively [in]

Returns:

• MSCB_SUCCESS –
  Successful completion
• 0 –
  Error

Declared in mscb/include/mscb.h:439, defined in mscb/src/mscb.cxx:4944