API

The API divided into two main categories of the calls:

  • Control and Management functions used to find and list attached devices, open and close connection to selected device and debug logging.
  • Attribute Access function are implementing the core library functionality. These calls are used to read and write data for the selected operating modes and control the library behavior.

Every API call, whether it was successful or failed the SIGNALYZER_STATUS code is returned to help to determine the results of the call and reason for the failure.

Quick reference table

Function Description
Control and Management functions
signalyzer_new Create and Initialize Signalyzer context
signalyzer_dispose Dispose and clean-up the Signalyzer context
signalyzer_get_device_list Retrieve detailed list of attached devices
signalyzer_open Open a connection to specified Signalyzer device
signalyzer_close Close a connection with previously opened Signalyzer device
signalyzer_get_attribute_id Retrieve Attribute ID from its ASCII name
Attribute Access functions
signalyzer_write_u8 Write an unsigned char (byte)
signalyzer_write_u16 Write an unsigned short (16-bits)
signalyzer_write_u32 Write an unsigned int (32-bits)
signalyzer_write_u64 Write an unsigned long long (64-bits)
signalyzer_write Write set number of bits
signalyzer_read_u8 Read an unsigned char (byte)
signalyzer_read_u16 Read an unsigned short (16-bits)
signalyzer_read_u32 Read an unsigned int (32-bits)
signalyzer_read_u64 Read an unsigned long long (64-bits)
signalyzer_read Read set number of bits
signalyzer_write_read_u8 Write and Reads an unsigned char (byte)
signalyzer_write_read_u16 Write and Reads an unsigned short (16-bits)
signalyzer_write_read_u32 Write and Reads an unsigned int (32-bits)
signalyzer_write_read_u64 Write and Reads an unsigned long long (64-bits)
signalyzer_write_read Write and Reads set number of bits

API Functions Description

signalyzer_new

Creates Signalyzer context.

signalyzer_status_t signalyzer_new
(
  signalyzer_handle_t * signalyzer_handle
);

Parameters
  • signalyzer_handle - A pointer to signalyzer_handle_t type variable where function will return a device context handle.
Return
  • SIGNALYZER_STATUS_OK is returned if API call completed successfully, otherwise specific error code is returned. Refer to SIGNALYZER_STATUS section for details on specific error codes.

signalyzer_dispose

Disposes previously created context.

signalyzer_status_t signalyzer_dispose
(
  signalyzer_handle_t signalyzer_handle
);

Parameters
  • signalyzer_handle_t - Handle of the device context.
Return
  • SIGNALYZER_STATUS_OK is returned if API call completed successfully, otherwise specific error code is returned. Refer to SIGNALYZER_STATUS section for details on specific error codes.

signalyzer_get_device_list

Retrieves list of attached devices.

signalyzer_status_t signalyzer_get_device_list
(
  signalyzer_handle_t signalyzer_handle,
  void * device_list,
  uint32_t * number_of_devices
);

Parameters
  • signalyzer_handle - Handle of the device context.
  • device_list - Pointer to structure where API shall return list of devices.
  • number_of_devices - Pointer to unsigned integer where API shall return total number of devices found.
Return
  • SIGNALYZER_STATUS_OK is returned if API call completed successfully, otherwise specific error code is returned. Refer to SIGNALYZER_STATUS section for details on specific error codes.

signalyzer_open

Opens a connection with specified Signalyzer device

signalyzer_status_t signalyzer_open
(
  signalyzer_handle_t signalyzer_handle,
  void * device_identifier
);

Parameters
  • signalyzer_handle - Handle of the device context.
  • device_identifier - A pointer to string or structure containing device identifier information.
Return
  • SIGNALYZER_STATUS_OK is returned if API call completed successfully, otherwise specific error code is returned. Refer to SIGNALYZER_STATUS section for details on specific error codes.

signalyzer_close

Closes connection with previously opened Signalyzer device.

signalyzer_status_t signalyzer_close
(
  signalyzer_handle_t signalyzer_handle
);

Parameters
  • signalyzer_handle - Handle of the device context.
Return
  • SIGNALYZER_STATUS_OK is returned if API call completed successfully, otherwise specific error code is returned. Refer to SIGNALYZER_STATUS section for details on specific error codes.

signalyzer_get_attribute_id

Retrieve Attribute ID from its ASCII name. The corresponding operating mode must be enabled to be able to retrieve the Attribute ID from its name.

signalyzer_status_t signalyzer_get_attribute_id
(
  signalyzer_handle_t signalyzer_handle, 
  signalyzer_port_t port,
  const char * attribute_name, 
  signalyzer_attribute_id_t * attribute_id
);

Parameters
  • signalyzer_handle - Handle of the device context.
  • port - Signalyzer Port current API call is addressing.
  • attribute_name - Pointer to Attribute Name string.
  • attribute_id - pointer to signalyzer_attribute_id_t variable where attribute ID will be returned.
Return
  • SIGNALYZER_STATUS_OK is returned if API call completed successfully, otherwise specific error code is returned. Refer to SIGNALYZER_STATUS section for details on specific error codes.

signalyzer_write_u8

Write an unsigned char (byte)

signalyzer_status_t signalyzer_write_u8
(
  signalyzer_handle_t signalyzer_handle, 
  signalyzer_port_t port,	
  signalyzer_attribute_id_t attribute_id,
  signalyzer_address_t address, 
  uint8_t write_value
);

Parameters
  • signalyzer_handle - Handle of the device context.
  • port - Signalyzer Port current API call is addressing.
  • attribute_id - Attribute current API call is addressing.
  • address - Address. The Address value usage depends on the attribute type being accessed and/or mode of operation. Please refer to Attribute specific documentation for details on usage of address parameter.
  • write_value - Value to be written to the Attribute location.
Return
  • SIGNALYZER_STATUS_OK is returned if API call completed successfully, otherwise specific error code is returned. Refer to SIGNALYZER_STATUS section for details on specific error codes.

signalyzer_write_u16

Write an unsigned short (16-bits)

signalyzer_status_t signalyzer_write_u16
(
  signalyzer_handle_t signalyzer_handle, 
  signalyzer_port_t port,
  signalyzer_attribute_id_t attribute_id,
  signalyzer_address_t address, 
  uint16_t write_value
);

Parameters
  • signalyzer_handle - Handle of the device context.
  • port - Signalyzer Port current API call is addressing.
  • attribute_id - Attribute current API call is addressing.
  • address - Address. The Address value usage depends on the attribute type being accessed and/or mode of operation. Please refer to Attribute specific documentation for details on usage of address parameter.
  • write_value - Value to be written to the Attribute location.
Return
  • SIGNALYZER_STATUS_OK is returned if API call completed successfully, otherwise specific error code is returned. Refer to SIGNALYZER_STATUS section for details on specific error codes.

signalyzer_write_u32

Writes an unsigned int (32-bits)

signalyzer_status_t signalyzer_write_u32
(
  signalyzer_handle_t signalyzer_handle, 
  signalyzer_port_t port,
  signalyzer_attribute_id_t attribute_id,
  signalyzer_address_t address, 
  uint32_t write_value
);

Parameters
  • signalyzer_handle - Handle of the device context.
  • port - Signalyzer Port current API call is addressing.
  • attribute_id - Attribute current API call is addressing.
  • address - Address. The Address value usage depends on the attribute type being accessed and/or mode of operation. Please refer to Attribute specific documentation for details on usage of address parameter.
  • write_value - Value to be written to the Attribute location.
Return
  • SIGNALYZER_STATUS_OK is returned if API call completed successfully, otherwise specific error code is returned. Refer to SIGNALYZER_STATUS section for details on specific error codes.

signalyzer_write_u64

Writes an unsigned long long (64-bits)

signalyzer_status_t signalyzer_write_u64
(
  signalyzer_handle_t signalyzer_handle, 
  signalyzer_port_t port,
  signalyzer_attribute_id_t attribute_id,
  signalyzer_address_t address, 
  uint64_t write_value
);

Parameters
  • signalyzer_handle - Handle of the device context.
  • port - Signalyzer Port current API call is addressing.
  • attribute_id - Attribute current API call is addressing.
  • address - Address. The Address value usage depends on the attribute type being accessed and/or mode of operation. Please refer to Attribute specific documentation for details on usage of address parameter.
  • write_value - Value to be written to the Attribute location.
Return
  • SIGNALYZER_STATUS_OK is returned if API call completed successfully, otherwise specific error code is returned. Refer to SIGNALYZER_STATUS section for details on specific error codes.

signalyzer_write

Writes set number of bits

signalyzer_status_t signalyzer_write
(
  signalyzer_handle_t signalyzer_handle, 
  signalyzer_port_t port,
  signalyzer_attribute_id_t attribute_id,
  signalyzer_address_t address, 
  void * write_buffer, 
  uint32_t bits_to_write
);

Parameters
  • signalyzer_handle - Handle of the device context.
  • port - Signalyzer Port current API call is addressing.
  • attribute_id - Attribute current API call is addressing.
  • address - Address. The Address value usage depends on the attribute type being accessed and/or mode of operation. Please refer to Attribute specific documentation for details on usage of address parameter.
  • write_buffer - Pointer to a buffer containing data to be written.
  • bits_to_write - Number of bits to be written.
Return
  • SIGNALYZER_STATUS_OK is returned if API call completed successfully, otherwise specific error code is returned. Refer to SIGNALYZER_STATUS section for details on specific error codes.

signalyzer_read_u8

Reads an unsigned char (byte)

signalyzer_status_t signalyzer_read_u8
(
  signalyzer_handle_t signalyzer_handle, 
  signalyzer_port_t port,
  signalyzer_attribute_id_t attribute_id,
  signalyzer_address_t address, 
  uint8_t * read_value
);

Parameters
  • signalyzer_handle - Handle of the device context.
  • port - Signalyzer Port current API call is addressing.
  • attribute_id - Attribute current API call is addressing.
  • address - Address. The Address value usage depends on the attribute type being accessed and/or mode of operation. Please refer to Attribute specific documentation for details on usage of address parameter.
  • read_value - Poiner where read Value will be stored.
Return
  • SIGNALYZER_STATUS_OK is returned if API call completed successfully, otherwise specific error code is returned. Refer to SIGNALYZER_STATUS section for details on specific error codes.

signalyzer_read_u16

Reads an unsigned short (16-bits)

signalyzer_status_t signalyzer_read_u16
(
  signalyzer_handle_t signalyzer_handle, 
  signalyzer_port_t port,
  signalyzer_attribute_id_t attribute_id,
  signalyzer_address_t address, 
  uint16_t * read_value
);

Parameters
  • signalyzer_handle - Handle of the device context.
  • port - Signalyzer Port current API call is addressing.
  • attribute_id - Attribute current API call is addressing.
  • address - Address. The Address value usage depends on the attribute type being accessed and/or mode of operation. Please refer to Attribute specific documentation for details on usage of address parameter.
  • read_value - Poiner where read Value will be stored.
Return
  • SIGNALYZER_STATUS_OK is returned if API call completed successfully, otherwise specific error code is returned. Refer to SIGNALYZER_STATUS section for details on specific error codes.

signalyzer_read_u32

Read an unsigned int (32-bits)

signalyzer_status_t signalyzer_read_u32
(
  signalyzer_handle_t signalyzer_handle, 
  signalyzer_port_t port,
  signalyzer_attribute_id_t attribute_id,
  signalyzer_address_t address, 
  uint32_t * read_value
);

Parameters
  • signalyzer_handle - Handle of the device context.
  • port - Signalyzer Port current API call is addressing.
  • attribute_id - Attribute current API call is addressing.
  • address - Address. The Address value usage depends on the attribute type being accessed and/or mode of operation. Please refer to Attribute specific documentation for details on usage of address parameter.
  • read_value - Poiner where read Value will be stored.
Return
  • SIGNALYZER_STATUS_OK is returned if API call completed successfully, otherwise specific error code is returned. Refer to SIGNALYZER_STATUS section for details on specific error codes.

signalyzer_read_u64

Read an unsigned long long (64-bits)

signalyzer_status_t signalyzer_read_u64
(
  signalyzer_handle_t signalyzer_handle, 
  signalyzer_port_t port,
  signalyzer_attribute_id_t attribute_id,
  signalyzer_address_t address, 
  uint64_t * read_value
);

Parameters
  • signalyzer_handle - Handle of the device context.
  • port - Signalyzer Port current API call is addressing.
  • attribute_id - Attribute current API call is addressing.
  • address - Address. The Address value usage depends on the attribute type being accessed and/or mode of operation. Please refer to Attribute specific documentation for details on usage of address parameter.
  • read_value - Poiner where read Value will be stored.
Return
  • SIGNALYZER_STATUS_OK is returned if API call completed successfully, otherwise specific error code is returned. Refer to SIGNALYZER_STATUS section for details on specific error codes.

signalyzer_read

Reads set number of bits

signalyzer_status_t signalyzer_read
(
  signalyzer_handle_t signalyzer_handle, 
  signalyzer_port_t port,
  signalyzer_attribute_id_t attribute_id,
  signalyzer_address_t address, 
  void * read_buffer, 
  uint32_t bits_to_read
);

Parameters
  • signalyzer_handle - Handle of the device context.
  • port - Signalyzer Port current API call is addressing.
  • attribute_id - Attribute current API call is addressing.
  • address - Address. The Address value usage depends on the attribute type being accessed and/or mode of operation. Please refer to Attribute specific documentation for details on usage of address parameter.
  • read_buffer - Poiner to a buffer where read data will be stored.
  • bits_to_read - Number of bits to be read.
Return
  • SIGNALYZER_STATUS_OK is returned if API call completed successfully, otherwise specific error code is returned. Refer to SIGNALYZER_STATUS section for details on specific error codes.

signalyzer_write_read_u8

Writes and Reads an unsigned char (byte)

signalyzer_status_t signalyzer_write_read_u8
(
  signalyzer_handle_t signalyzer_handle, 
  signalyzer_port_t port,
  signalyzer_attribute_id_t attribute_id,
  signalyzer_address_t address, 
  uint8_t write_value, 
  uint8_t * read_value
);

Parameters
  • signalyzer_handle - Handle of the device context.
  • port - Signalyzer Port current API call is addressing.
  • attribute_id - Attribute current API call is addressing.
  • address - Address. The Address value usage depends on the attribute type being accessed and/or mode of operation. Please refer to Attribute specific documentation for details on usage of address parameter.
  • write_value - Value to be written to the Attribute location.
  • read_value - Poiner where read Value will be stored.
Return
  • SIGNALYZER_STATUS_OK is returned if API call completed successfully, otherwise specific error code is returned. Refer to SIGNALYZER_STATUS section for details on specific error codes.

signalyzer_write_read_u16

Writes and Reads an unsigned short (16-bits)

signalyzer_status_t signalyzer_write_read_u16
(
  signalyzer_handle_t signalyzer_handle, 
  signalyzer_port_t port,
  signalyzer_attribute_id_t attribute_id,
  signalyzer_address_t address, 
  uint16_t write_value, 
  uint16_t * read_value
);

Parameters
  • signalyzer_handle - Handle of the device context.
  • port - Signalyzer Port current API call is addressing.
  • attribute_id - Attribute current API call is addressing.
  • address - Address. The Address value usage depends on the attribute type being accessed and/or mode of operation. Please refer to Attribute specific documentation for details on usage of address parameter.
  • write_value - Value to be written to the Attribute location.
  • read_value - Poiner where read Value will be stored.
Return
  • SIGNALYZER_STATUS_OK is returned if API call completed successfully, otherwise specific error code is returned. Refer to SIGNALYZER_STATUS section for details on specific error codes.

signalyzer_write_read_u32

Writes and Reads an unsigned int (32-bits)

signalyzer_status_t signalyzer_write_read_u32
(
  signalyzer_handle_t signalyzer_handle, 
  signalyzer_port_t port,
  signalyzer_attribute_id_t attribute_id,
  signalyzer_address_t address, 
  uint32_t write_value, 
  uint32_t * read_value
);

Parameters
  • signalyzer_handle - Handle of the device context.
  • port - Signalyzer Port current API call is addressing.
  • attribute_id - Attribute current API call is addressing.
  • address - Address. The Address value usage depends on the attribute type being accessed and/or mode of operation. Please refer to Attribute specific documentation for details on usage of address parameter.
  • write_value - Value to be written to the Attribute location.
  • read_value - Poiner where read Value will be stored.
Return
  • SIGNALYZER_STATUS_OK is returned if API call completed successfully, otherwise specific error code is returned. Refer to SIGNALYZER_STATUS section for details on specific error codes.

signalyzer_write_read_u64

Writes and Reads an unsigned long long (64-bits)

signalyzer_status_t signalyzer_write_read_u64
(
  signalyzer_handle_t signalyzer_handle, 
  signalyzer_port_t port,
  signalyzer_attribute_id_t attribute_id,
  signalyzer_address_t address, 
  uint64_t write_value, 
  uint64_t * read_value
);

Parameters
  • signalyzer_handle - Handle of the device context.
  • port - Signalyzer Port current API call is addressing.
  • attribute_id - Attribute current API call is addressing.
  • address - Address. The Address value usage depends on the attribute type being accessed and/or mode of operation. Please refer to Attribute specific documentation for details on usage of address parameter.
  • write_value - Value to be written to the Attribute location.
  • read_value - Poiner where read Value will be stored.
Return
  • SIGNALYZER_STATUS_OK is returned if API call completed successfully, otherwise specific error code is returned. Refer to SIGNALYZER_STATUS section for details on specific error codes.

signalyzer_write_read

Writes and Reads set number of bits

signalyzer_status_t signalyzer_write_read
(
  signalyzer_handle_t signalyzer_handle, 
  signalyzer_port_t port,
  signalyzer_attribute_id_t attribute_id,
  signalyzer_address_t address, 
  void * write_buffer, 
  uint32_t bits_to_write, 
  void * read_buffer, 
  uint32_t bits_to_read
);

Parameters
  • signalyzer_handle - Handle of the device context.
  • port - Signalyzer Port current API call is addressing.
  • attribute_id - Attribute current API call is addressing.
  • address - Address. The Address value usage depends on the attribute type being accessed and/or mode of operation. Please refer to Attribute specific documentation for details on usage of address parameter.
  • write_buffer - Pointer to a buffer containing data to be written.
  • bits_to_write - Number of bits to be written.
  • read_buffer - Poiner to a buffer where read data will be stored.
  • bits_to_read - Number of bits to be read.
Return
  • SIGNALYZER_STATUS_OK is returned if API call completed successfully, otherwise specific error code is returned. Refer to SIGNALYZER_STATUS section for details on specific error codes.