libtiepie-hw  1.1.4
Types

Data Structures

struct  tiepie_hw_date
 
struct  tiepie_hw_demo_info
 

Typedefs

typedef uint32_t tiepie_hw_handle
 Generic handle. More...
 
typedef uint8_t tiepie_hw_bool
 Boolean value one byte wide. More...
 
typedef uint8_t tiepie_hw_tristate
 TriState value one byte wide. More...
 
typedef void ** tiepie_hw_pointerarray
 Pointer array. More...
 
typedef void(* tiepie_hw_devicelist_callback) (void *data, uint32_t device_types, uint32_t serial_number)
 
typedef void(* tiepie_hw_handle_callback) (void *data, tiepie_hw_handle handle)
 
typedef void(* tiepie_hw_event_callback) (void *data, tiepie_hw_event event, uint32_t value)
 

Enumerations

enum  tiepie_hw_status {
  TIEPIE_HW_STATUS_VALUE_MODIFIED = 2 , TIEPIE_HW_STATUS_VALUE_CLIPPED = 1 , TIEPIE_HW_STATUS_SUCCESS = 0 , TIEPIE_HW_STATUS_UNSUCCESSFUL = -1 ,
  TIEPIE_HW_STATUS_NOT_SUPPORTED = -2 , TIEPIE_HW_STATUS_INVALID_HANDLE = -3 , TIEPIE_HW_STATUS_INVALID_VALUE = -4 , TIEPIE_HW_STATUS_INVALID_CHANNEL = -5 ,
  TIEPIE_HW_STATUS_INVALID_TRIGGER_SOURCE = -6 , TIEPIE_HW_STATUS_INVALID_DEVICE_TYPE = -7 , TIEPIE_HW_STATUS_INVALID_DEVICE_INDEX = -8 , TIEPIE_HW_STATUS_INVALID_PRODUCT_ID = -9 ,
  TIEPIE_HW_STATUS_INVALID_DEVICE_SERIALNUMBER = -10 , TIEPIE_HW_STATUS_OBJECT_GONE = -11 , TIEPIE_HW_STATUS_INTERNAL_ADDRESS = -12 , TIEPIE_HW_STATUS_NOT_CONTROLLABLE = -13 ,
  TIEPIE_HW_STATUS_BIT_ERROR = -14 , TIEPIE_HW_STATUS_NO_ACKNOWLEDGE = -15 , TIEPIE_HW_STATUS_INVALID_CONTAINED_DEVICE_SERIALNUMBER = -16 , TIEPIE_HW_STATUS_INVALID_INPUT = -17 ,
  TIEPIE_HW_STATUS_INVALID_OUTPUT = -18 , TIEPIE_HW_STATUS_NOT_AVAILABLE = -20 , TIEPIE_HW_STATUS_INVALID_FIRMWARE = -21 , TIEPIE_HW_STATUS_INVALID_INDEX = -22 ,
  TIEPIE_HW_STATUS_INVALID_EEPROM = -23 , TIEPIE_HW_STATUS_INITIALIZATION_FAILED = -24 , TIEPIE_HW_STATUS_LIBRARY_NOT_INITIALIZED = -25 , TIEPIE_HW_STATUS_NO_TRIGGER_ENABLED = -26 ,
  TIEPIE_HW_STATUS_SYNCHRONIZATION_FAILED = -29 , TIEPIE_HW_STATUS_INVALID_HS56_COMBINED_DEVICE = -30 , TIEPIE_HW_STATUS_MEASUREMENT_RUNNING = -31 , TIEPIE_HW_STATUS_WIRELESSTRIGGERMODULENOTCONNECTED = -32 ,
  TIEPIE_HW_STATUS_INITIALIZATION_ERROR_10001 = -10001 , TIEPIE_HW_STATUS_INITIALIZATION_ERROR_10002 = -10002 , TIEPIE_HW_STATUS_INITIALIZATION_ERROR_10003 = -10003 , TIEPIE_HW_STATUS_INITIALIZATION_ERROR_10004 = -10004 ,
  TIEPIE_HW_STATUS_INITIALIZATION_ERROR_10005 = -10005 , TIEPIE_HW_STATUS_INITIALIZATION_ERROR_10006 = -10006 , TIEPIE_HW_STATUS_INITIALIZATION_ERROR_10007 = -10007
}
 Status code. More...
 
enum  tiepie_hw_productid {
  TIEPIE_HW_PRODUCTID_NONE = 0 , TIEPIE_HW_PRODUCTID_COMBI = 2 , TIEPIE_HW_PRODUCTID_HS3 = 13 , TIEPIE_HW_PRODUCTID_HS4 = 15 ,
  TIEPIE_HW_PRODUCTID_HP3 = 18 , TIEPIE_HW_PRODUCTID_TP450 = 19 , TIEPIE_HW_PRODUCTID_HS4D = 20 , TIEPIE_HW_PRODUCTID_HS5 = 22 ,
  TIEPIE_HW_PRODUCTID_HS6 = 24 , TIEPIE_HW_PRODUCTID_HS6D = 25 , TIEPIE_HW_PRODUCTID_ATS610004D = 31 , TIEPIE_HW_PRODUCTID_ATS605004D = 32 ,
  TIEPIE_HW_PRODUCTID_WS6 = 34 , TIEPIE_HW_PRODUCTID_WS5 = 35 , TIEPIE_HW_PRODUCTID_WS6D = 36 , TIEPIE_HW_PRODUCTID_ATS610004DW = 37 ,
  TIEPIE_HW_PRODUCTID_ATS605004DW = 38 , TIEPIE_HW_PRODUCTID_WS4D = 39 , TIEPIE_HW_PRODUCTID_ATS5004DW = 40
}
 ProductID IDs for products. More...
 
enum  tiepie_hw_event {
  TIEPIE_HW_EVENT_INVALID = 0 , TIEPIE_HW_EVENT_OBJECT_REMOVED = 1 , TIEPIE_HW_EVENT_OSCILLOSCOPE_DATA_READY = 2 , TIEPIE_HW_EVENT_OSCILLOSCOPE_DATA_OVERFLOW = 3 ,
  TIEPIE_HW_EVENT_OSCILLOSCOPE_SURE_CONNECT_COMPLETED = 4 , TIEPIE_HW_EVENT_OSCILLOSCOPE_TRIGGERED = 5 , TIEPIE_HW_EVENT_GENERATOR_BURST_COMPLETED = 6 , TIEPIE_HW_EVENT_GENERATOR_CONTROLLABLE_CHANGED = 7 ,
  TIEPIE_HW_EVENT_SERVER_STATUS_CHANGED = 8 , TIEPIE_HW_EVENT_OSCILLOSCOPE_SAFEGROUND_ERROR = 9 , TIEPIE_HW_EVENT_DEVICE_BATTERY_STATUS_CHANGED = 11 , TIEPIE_HW_EVENT_OSCILLOSCOPE_WIRELESS_SYNCHRONIZATION_ERROR = 12
}
 Event IDs for events that can be used by LibTiePie to notify the calling application of changes with the instrument. More...
 
enum  tiepie_hw_demosignal {
  TIEPIE_HW_DEMOSIGNAL_NONE = 0 , TIEPIE_HW_DEMOSIGNAL_SINE = 1 , TIEPIE_HW_DEMOSIGNAL_TRIANGLE = 2 , TIEPIE_HW_DEMOSIGNAL_SQUARE = 3 ,
  TIEPIE_HW_DEMOSIGNAL_DC = 4 , TIEPIE_HW_DEMOSIGNAL_RUNT = 5 , TIEPIE_HW_DEMOSIGNAL_I2C_SCL = 100 , TIEPIE_HW_DEMOSIGNAL_I2C_SDA = 101 ,
  TIEPIE_HW_DEMOSIGNAL_UART_9600_8N1 = 200 , TIEPIE_HW_DEMOSIGNAL_UART_9600_7E2 = 201 , TIEPIE_HW_DEMOSIGNAL_RS232_9600_8N1 = 300 , TIEPIE_HW_DEMOSIGNAL_RS232_9600_8O15 = 301 ,
  TIEPIE_HW_DEMOSIGNAL_RS485_9600_8N1 = 400 , TIEPIE_HW_DEMOSIGNAL_RS485_9600_8N1MD = 401 , TIEPIE_HW_DEMOSIGNAL_CAN_250000 = 500 , TIEPIE_HW_DEMOSIGNAL_CAN_250000_HI = 501 ,
  TIEPIE_HW_DEMOSIGNAL_CAN_250000_LO = 502 , TIEPIE_HW_DEMOSIGNAL_CANFD_250000 = 600 , TIEPIE_HW_DEMOSIGNAL_CANFD_250000_HI = 601 , TIEPIE_HW_DEMOSIGNAL_CANFD_250000_LO = 602 ,
  TIEPIE_HW_DEMOSIGNAL_DMX512 = 700 , TIEPIE_HW_DEMOSIGNAL_LIN_19200 = 800
}
 Demo signal type IDs, for demo oscilloscope channels. See Demo signals. More...
 

Detailed Description

Typedef Documentation

◆ tiepie_hw_handle

typedef uint32_t tiepie_hw_handle

Generic handle.

◆ tiepie_hw_bool

typedef uint8_t tiepie_hw_bool

Boolean value one byte wide.

See also
tiepie_hw_bool values

◆ tiepie_hw_tristate

typedef uint8_t tiepie_hw_tristate

TriState value one byte wide.

See also
tiepie_hw_tristate values

◆ tiepie_hw_pointerarray

typedef void** tiepie_hw_pointerarray

Pointer array.

See also
Pointer array

◆ tiepie_hw_devicelist_callback

typedef void(* tiepie_hw_devicelist_callback) (void *data, uint32_t device_types, uint32_t serial_number)

◆ tiepie_hw_handle_callback

typedef void(* tiepie_hw_handle_callback) (void *data, tiepie_hw_handle handle)

◆ tiepie_hw_event_callback

typedef void(* tiepie_hw_event_callback) (void *data, tiepie_hw_event event, uint32_t value)

Enumeration Type Documentation

◆ tiepie_hw_status

Status code.

These codes show the status of the last called LibTiePie function.

0 means ok
<0 means error
>0 means ok, but with a side effect

Enumerator
TIEPIE_HW_STATUS_VALUE_MODIFIED 

One of the parameters of the last called function was within the valid range but not available. The closest valid value is set.

TIEPIE_HW_STATUS_VALUE_CLIPPED 

One of the parameters of the last called function was outside the valid range and clipped to the closest limit.

TIEPIE_HW_STATUS_SUCCESS 

The function executed successfully.

TIEPIE_HW_STATUS_UNSUCCESSFUL 

An error occurred during execution of the last called function.

TIEPIE_HW_STATUS_NOT_SUPPORTED 

The requested functionality is not supported by the hardware.

TIEPIE_HW_STATUS_INVALID_HANDLE 

The handle to the device is invalid.

TIEPIE_HW_STATUS_INVALID_VALUE 

The requested value is invalid.

TIEPIE_HW_STATUS_INVALID_CHANNEL 

The requested channel number is invalid.

TIEPIE_HW_STATUS_INVALID_TRIGGER_SOURCE 

The requested trigger source is invalid.

TIEPIE_HW_STATUS_INVALID_DEVICE_TYPE 

The device type is invalid.

TIEPIE_HW_STATUS_INVALID_DEVICE_INDEX 

The device index is invalid, must be < LstGetCount().

TIEPIE_HW_STATUS_INVALID_PRODUCT_ID 

There is no device with the requested product ID.

TIEPIE_HW_STATUS_INVALID_DEVICE_SERIALNUMBER 

There is no device with the requested serial number.

TIEPIE_HW_STATUS_OBJECT_GONE 

The object indicated by the handle is no longer available.

TIEPIE_HW_STATUS_INTERNAL_ADDRESS 

The requested I2C address is an internally used address in the device.

TIEPIE_HW_STATUS_NOT_CONTROLLABLE 

The generator is currently not controllable, see tiepie_hw_generator_is_controllable.

TIEPIE_HW_STATUS_BIT_ERROR 

The requested I2C operation generated a bit error.

TIEPIE_HW_STATUS_NO_ACKNOWLEDGE 

The requested I2C operation generated "No acknowledge".

TIEPIE_HW_STATUS_INVALID_CONTAINED_DEVICE_SERIALNUMBER 

A device with the requested serial number is not available in the combined instrument, see tiepie_hw_devicelistitem_get_contained_serial_numbers.

TIEPIE_HW_STATUS_INVALID_INPUT 

The requested trigger input is invalid.

TIEPIE_HW_STATUS_INVALID_OUTPUT 

The requested trigger output is invalid.

TIEPIE_HW_STATUS_NOT_AVAILABLE 

With the current settings, the requested functionality is not available.

TIEPIE_HW_STATUS_INVALID_FIRMWARE 

The currently used firmware is not supported.

TIEPIE_HW_STATUS_INVALID_INDEX 

The requested index is invalid.

TIEPIE_HW_STATUS_INVALID_EEPROM 

The instrument's EEPROM content is damaged, please contact TiePie engineering support.

TIEPIE_HW_STATUS_INITIALIZATION_FAILED 

The instrument's initialization failed, please contact TiePie engineering support.

TIEPIE_HW_STATUS_LIBRARY_NOT_INITIALIZED 

The library is not initialized, see tiepie_hw_init().

TIEPIE_HW_STATUS_NO_TRIGGER_ENABLED 

The current setup requires a trigger input to be enabled.

TIEPIE_HW_STATUS_SYNCHRONIZATION_FAILED 

Synchronization of the instruments has failed.

TIEPIE_HW_STATUS_INVALID_HS56_COMBINED_DEVICE 

At least one Handyscope HS6 (DIFF) / WiFiScope WS6 (DIFF) must be located at the beginning or end of the CMI daisy chain.

TIEPIE_HW_STATUS_MEASUREMENT_RUNNING 

A measurement is already running.

TIEPIE_HW_STATUS_WIRELESSTRIGGERMODULENOTCONNECTED 
TIEPIE_HW_STATUS_INITIALIZATION_ERROR_10001 

Initialization error 10001.

TIEPIE_HW_STATUS_INITIALIZATION_ERROR_10002 

Initialization error 10002.

TIEPIE_HW_STATUS_INITIALIZATION_ERROR_10003 

Initialization error 10003.

TIEPIE_HW_STATUS_INITIALIZATION_ERROR_10004 

Initialization error 10004.

TIEPIE_HW_STATUS_INITIALIZATION_ERROR_10005 

Initialization error 10005.

TIEPIE_HW_STATUS_INITIALIZATION_ERROR_10006 

Initialization error 10006.

TIEPIE_HW_STATUS_INITIALIZATION_ERROR_10007 

Initialization error 10007.

◆ tiepie_hw_productid

ProductID IDs for products.

Enumerator
TIEPIE_HW_PRODUCTID_NONE 

Unknown/invalid TIEPIE_HW_ID.

TIEPIE_HW_PRODUCTID_COMBI 

Combined instrument.

TIEPIE_HW_PRODUCTID_HS3 

Handyscope TIEPIE_HW_HS3.

TIEPIE_HW_PRODUCTID_HS4 

Handyscope TIEPIE_HW_HS4.

TIEPIE_HW_PRODUCTID_HP3 

Handyprobe TIEPIE_HW_HP3.

TIEPIE_HW_PRODUCTID_TP450 

TIEPIE_HW_TP450.

TIEPIE_HW_PRODUCTID_HS4D 

Handyscope TIEPIE_HW_HS4-TIEPIE_HW_DIFF.

TIEPIE_HW_PRODUCTID_HS5 

Handyscope TIEPIE_HW_HS5.

TIEPIE_HW_PRODUCTID_HS6 

Handyscope TIEPIE_HW_HS6.

TIEPIE_HW_PRODUCTID_HS6D 

Handyscope TIEPIE_HW_HS6 TIEPIE_HW_DIFF.

TIEPIE_HW_PRODUCTID_ATS610004D 

TIEPIE_HW_ATS610004D.

TIEPIE_HW_PRODUCTID_ATS605004D 

TIEPIE_HW_ATS605004D.

TIEPIE_HW_PRODUCTID_WS6 

WiFiScope TIEPIE_HW_WS6.

TIEPIE_HW_PRODUCTID_WS5 

WiFiScope TIEPIE_HW_WS5.

TIEPIE_HW_PRODUCTID_WS6D 

WiFiScope TIEPIE_HW_WS6D.

TIEPIE_HW_PRODUCTID_ATS610004DW 

TIEPIE_HW_ATS610004DW.

TIEPIE_HW_PRODUCTID_ATS605004DW 

TIEPIE_HW_ATS605004DW.

TIEPIE_HW_PRODUCTID_WS4D 

WiFiScope TIEPIE_HW_WS4D.

TIEPIE_HW_PRODUCTID_ATS5004DW 

TIEPIE_HW_ATS5004DW.

◆ tiepie_hw_event

Event IDs for events that can be used by LibTiePie to notify the calling application of changes with the instrument.

See also object callbacks.

Enumerator
TIEPIE_HW_EVENT_INVALID 

This event ID value should not occur.

TIEPIE_HW_EVENT_OBJECT_REMOVED 

Event ID for the event indicating that an object was removed.

TIEPIE_HW_EVENT_OSCILLOSCOPE_DATA_READY 

Event ID for the event indicating that the oscilloscope measurement is ready.

TIEPIE_HW_EVENT_OSCILLOSCOPE_DATA_OVERFLOW 

Event ID for the event indicating that the data overflow occurred during a streaming measurement.

TIEPIE_HW_EVENT_OSCILLOSCOPE_SURE_CONNECT_COMPLETED 

Event ID for the event indicating that the connection test is ready.

TIEPIE_HW_EVENT_OSCILLOSCOPE_TRIGGERED 

Event ID for the event indicating that the oscilloscope has triggered.

TIEPIE_HW_EVENT_GENERATOR_BURST_COMPLETED 

Event ID for the event indicating that the generator burst is completed.

TIEPIE_HW_EVENT_GENERATOR_CONTROLLABLE_CHANGED 

Event ID for the event indicating that the generator controllable state has changed.

TIEPIE_HW_EVENT_SERVER_STATUS_CHANGED 

XXX.

TIEPIE_HW_EVENT_OSCILLOSCOPE_SAFEGROUND_ERROR 

Event ID for the event indicating that the oscilloscope channel SafeGround was disabled because of a too large ground current. The value parameter of the event contains the channel number (0 to ChannelCount-1).

TIEPIE_HW_EVENT_DEVICE_BATTERY_STATUS_CHANGED 

XXX.

TIEPIE_HW_EVENT_OSCILLOSCOPE_WIRELESS_SYNCHRONIZATION_ERROR 

XXX.

◆ tiepie_hw_demosignal

Demo signal type IDs, for demo oscilloscope channels. See Demo signals.

Enumerator
TIEPIE_HW_DEMOSIGNAL_NONE 

Disable signal.

TIEPIE_HW_DEMOSIGNAL_SINE 

Generate a sine wave signal.

TIEPIE_HW_DEMOSIGNAL_TRIANGLE 

Generate a triangular signal.

TIEPIE_HW_DEMOSIGNAL_SQUARE 

Generate a square wave signal.

TIEPIE_HW_DEMOSIGNAL_DC 

Generate a DC level.

TIEPIE_HW_DEMOSIGNAL_RUNT 

Generate a pulse signal with a runt pulse.

TIEPIE_HW_DEMOSIGNAL_I2C_SCL 

Generate an I2C SCL signal.

TIEPIE_HW_DEMOSIGNAL_I2C_SDA 

Generate an I2C SDA signal.

TIEPIE_HW_DEMOSIGNAL_UART_9600_8N1 

Generate a UART signal, 9600 baud, 8 bits, no parity, 1 stop bit.

TIEPIE_HW_DEMOSIGNAL_UART_9600_7E2 

Generate a UART signal, 9600 baud, 7 bits, even parity, 2 stop bits.

TIEPIE_HW_DEMOSIGNAL_RS232_9600_8N1 

Generate a RS232 signal, 9600 baud, 8 bits, no parity, 1 stop bit.

TIEPIE_HW_DEMOSIGNAL_RS232_9600_8O15 

Generate a RS232 signal, 9600 baud, 8 bits, odd parity, 1.5 stop bits.

TIEPIE_HW_DEMOSIGNAL_RS485_9600_8N1 

Generate a RS458 signal, 9600 baud, 8 bits, no parity, 1 stop bit.

TIEPIE_HW_DEMOSIGNAL_RS485_9600_8N1MD 

Generate a RS458 signal, 9600 baud, 8 bits, no parity, 1 stop bit MultiDrop.

TIEPIE_HW_DEMOSIGNAL_CAN_250000 

Generate a differential CAN signal, 250 kbps.

TIEPIE_HW_DEMOSIGNAL_CAN_250000_HI 

Generate a CAN-High signal, 250 kbps.

TIEPIE_HW_DEMOSIGNAL_CAN_250000_LO 

Generate a CAN-Low signal, 250 kbps.

TIEPIE_HW_DEMOSIGNAL_CANFD_250000 

Generate a differential CANFD signal, 250 kbps.

TIEPIE_HW_DEMOSIGNAL_CANFD_250000_HI 

Generate a CANFD-High signal, 250 kbps.

TIEPIE_HW_DEMOSIGNAL_CANFD_250000_LO 

Generate a CANFD-Low signal, 250 kbps.

TIEPIE_HW_DEMOSIGNAL_DMX512 

Generate a DMX 512 signal.

TIEPIE_HW_DEMOSIGNAL_LIN_19200 

Generate a LIN bus signal, 19200 bps.