PulsarAPI
USB and TCP/IP control library for Pulsar 320E
Classes | Macros | Typedefs | Enumerations | Functions
PulsarAPI.h File Reference

This module contains external definitions for the High Level User Application Programming Interface DLL functions in the Pulsar320 and Pulsar320E projects. More...

Go to the source code of this file.

Classes

struct  API_CHAN_CONFIG_STRUCT_T
 Channel/output configuration struct. More...
 

Macros

#define _PULSARAPI_H
 
#define CALLSPEC
 
#define PULSAR_API   extern "C"
 
#define API_PULSAR_PRODUCT_NAME   "Ai Pulsar 320 Controller"
 
#define MPD_TYPES
 
#define API_NUM_CHAN   2
 
#define API_NUM_TRIG   2
 
#define API_CHAN_CONFIG_DEFAULT   1
 
#define API_CHAN_CONFIG_ACTIVE   2
 
#define API_NUM_OPTIONAL_TESTS   1
 
#define API_MAX_ROTARY   999
 
#define API_DIP_MODE0   0x1
 
#define API_DIP_MODE1   0x2
 
#define API_DIP_MODE2   0x4
 
#define API_DIP_MODE3   0x8
 
#define API_TRIG_IN1   0x1
 
#define API_TRIG_IN2   0x2
 
#define API_CONN_LH_DETECT   0x1
 
#define API_CONN_USBDETECT   0x2
 
#define API_CONN_PCPRESENT   0x4
 
#define API_CONN_PC_READY   0x8
 
#define API_SUPPLY_VIN_ON   0x1
 
#define API_SUPPLY_LV_ON   0x2
 
#define API_SUPPLY_HV_ON   0x4
 
#define API_EXP_GPIN1   0x1
 
#define API_EXP_GPIN2   0x2
 
#define API_EXP_GPINOUT1   0x4
 
#define API_EXP_GPINOUT2   0x8
 
#define API_SIGNATECH_I   0x01
 
#define API_SIGNATECH_II   0x02
 
#define API_AI_VIN_SWMON   0x6F
 
#define API_AI_V_HV_STRINGMON   0x8C
 
#define API_AI_V_LV_STRINGMON   0xFF
 
#define API_AI_VCH1MON   0xFF
 
#define API_AI_VCH2MON   0xFF
 
#define API_AI_VCH3MON   0xFF
 
#define API_AI_VCH4MON   0xFF
 
#define API_AI_GND1   0x74
 
#define API_AI_SIG1_ID1_MON   0xFF
 
#define API_AI_SIG1_ID2_MON   0xFF
 
#define API_AI_CH1_DRV_LVL   0xFF
 
#define API_AI_CH2_DRV_LVL   0xFF
 
#define API_AI_CH3_DRV_LVL   0xFF
 
#define API_AI_CH4_DRV_LVL   0xFF
 
#define API_AI_GND2   0x75
 
#define API_AI_10VMON   0xFF
 
#define API_AI_CH1CURRSENS   0xA0
 
#define API_AI_CH2CURRSENS   0xA1
 
#define API_AI_CH3CURRSENS   0xFF
 
#define API_AI_CH4CURRSENS   0xFF
 
#define API_AI_INT_TEMP   0xFF
 
#define API_AI_GND3   0xFF
 
#define API_AI_33VMON   0xFF
 
#define API_AI_5VMON   0x71
 
#define API_AI_15VMON   0x70
 
#define API_AI_15VSWMON   0x72
 
#define API_AI_USB5VMON   0x73
 
#define API_AI_CH1INTTEMP   0x79
 
#define API_AI_CH2INTTEMP   0x65
 

Typedefs

typedef unsigned char UINT8_T
 
typedef unsigned short UINT16_T
 
typedef unsigned int UINT32_T
 
typedef char INT8_T
 
typedef short INT16_T
 
typedef int INT32_T
 
typedef unsigned char BOOLEAN_T
 
typedef float FLOAT32_T
 
typedef INT16_T ERRCODE_T
 API Error Code type – error codes documented in separate "ecodes.ini" file.
 

Enumerations

enum  API_MODE_T {
  API_MODE_PULSED , API_MODE_REPEAT , API_MODE_TIMING_BYPASS , API_MODE_INTERNAL_TRIGGER ,
  API_NUM_MODE
}
 Define possible operating modes. More...
 
enum  API_CHAN_T { API_CHAN_1 = 1 , API_CHAN_2 }
 Define the drive channel identifiers used with the API interface.
 
enum  { API_TRIG_NONE , API_TRIG_1 , API_TRIG_2 }
 Define the trigger input identifiers used with the API interface. More...
 
enum  {
  API_POWER_TEST , API_RAM_TEST , API_FLASH_TEST , API_EXTIO_TEST ,
  API_EEPROM_TEST , API_EXT_DAC_TEST , API_SCI_TEST , API_NUM_TESTS
}
 Define identifiers for diagnostics tests.
 

Functions

UINT16_T api_get_dll_version (void)
 Returns the current version number of this software. More...
 
UINT32_T api_get_dll_full_version (void)
 Returns the full version number of this software. More...
 
ERRCODE_T api_get_error_name (ERRCODE_T ecode, char *nameptr, UINT16_T namelen)
 Returns the name of the error associated with the code. More...
 
ERRCODE_T api_get_error_text (ERRCODE_T ecode, char *textptr, UINT16_T textlen)
 Returns the text description of the error associated with the code. More...
 
ERRCODE_T api_init (UINT8_T port, const INT8_T *product_name, const INT8_T *serial_num)
 Initializes the connection to a specific Pulsar. More...
 
ERRCODE_T api_connect (UINT8_T port, const INT8_T *product_name, const INT8_T *ip_addr)
 Initializes the connection to a specific Pulsar. More...
 
ERRCODE_T api_get_pulsar_version (UINT8_T port, INT8_T *fw_version, INT8_T *hw_version, INT8_T *serial_num)
 Reads firmware version, hardware version, and serial number Each string can be up to 32 characters long. More...
 
ERRCODE_T api_get_pulsar_ipaddr (UINT8_T port, INT8_T *ip_addr, INT8_T *subnet, INT8_T *gateway, INT8_T *mac_addr)
 Reads iip configuration settings from the device Each string can be up to 32 characters long. More...
 
ERRCODE_T api_get_status (UINT8_T port)
 Reads status information from the device. More...
 
ERRCODE_T api_run_diags (UINT8_T port, UINT8_T test_num)
 Runs one or all of the built in diagnostics. More...
 
ERRCODE_T api_get_channel_config (UINT8_T port, UINT8_T chan, UINT8_T type, API_CHAN_CONFIG_STRUCT_T *config_data)
 Gets the configuration data for one drive channel. More...
 
ERRCODE_T api_set_channel_config (UINT8_T port, UINT8_T chan, UINT8_T type, API_CHAN_CONFIG_STRUCT_T *config_data)
 Sets the configuration data for one drive channel. More...
 
ERRCODE_T api_set_channel_config_nochecks (UINT8_T port, UINT8_T chan, UINT8_T type, API_CHAN_CONFIG_STRUCT_T *config_data)
 Sets the configuration data for one drive channel. More...
 
ERRCODE_T api_trigger (UINT8_T port, UINT8_T trig)
 Generates a software trigger on the selected trigger channel. More...
 
ERRCODE_T api_calc_led_temp (UINT8_T port, UINT8_T ch, UINT32_T width, FLOAT32_T current, FLOAT32_T *temp)
 Calculates the expected LED junction temperature based on the information stored in the lighthead data structure and the width and current information passed. More...
 
ERRCODE_T api_calc_max_width (UINT8_T port, UINT8_T ch, FLOAT32_T current, UINT32_T *width)
 Calculates the maximum pulse width for the selected channel based on the information stored in the lighthead data structure and the current information passed. More...
 
ERRCODE_T api_calc_max_current (UINT8_T port, UINT8_T ch, UINT32_T width, FLOAT32_T *current)
 Calculates the maximum pulse current for the selected channel based on the information stored in the lighthead data structure and the width information passed. More...
 
ERRCODE_T api_calc_supply_voltage (UINT8_T port, UINT8_T ch, UINT32_T width, FLOAT32_T current, FLOAT32_T *voltage)
 Calculates the required supply voltage for a given width and current. More...
 
ERRCODE_T api_calc_max_freq (UINT8_T port, UINT8_T ch, UINT32_T width, FLOAT32_T current, UINT16_T *freq)
 Calculates the maximum frequency allowed for a given width and current. More...
 
ERRCODE_T api_measure_drive_current (UINT8_T port, UINT8_T ch, FLOAT32_T *current)
 Measures the drive current of the selected drive channel. More...
 
ERRCODE_T api_measure_voltage (UINT8_T port, UINT8_T id, FLOAT32_T *voltage)
 Measures the voltage of one of the signals monitored by the Pulsar. More...
 
ERRCODE_T api_get_user_data (UINT8_T port, UINT16_T *rotary, UINT8_T *dip, UINT8_T *trigger, UINT8_T *connect, UINT8_T *supply, UINT8_T *expansion)
 Gathers various information about the operating state of the Pulsar. More...
 
ERRCODE_T api_get_light_data (UINT8_T port, UINT8_T *sig_model, UINT8_T *sig1_id, char *sig2_pn, char *sig2_sn)
 Gathers information regarding the lighthead type. More...
 
ERRCODE_T api_get_light_data2 (UINT8_T port, UINT8_T channel, char *sig2_pn)
 Get Signatech II lighthead part and serial number. More...
 
ERRCODE_T api_set_stored_data (UINT8_T port, UINT8_T *data, UINT8_T len)
 Saves a block of Ai defined data to EEPROM. More...
 
ERRCODE_T api_get_stored_data (UINT8_T port, UINT8_T *data, UINT8_T len)
 Reads a block of Ai defined data from EEPROM. More...
 
ERRCODE_T api_shutdown (UINT8_T port)
 Shuts down the connection to a specific Pulsar. More...
 
ERRCODE_T api_set_configuration (UINT8_T port, UINT8_T *slew_rate, UINT8_T *diff_trigger, UINT8_T limit48v, UINT8_T disable_prot)
 Set hardware configuration. More...
 
ERRCODE_T api_get_configuration (UINT8_T port, UINT8_T *pslew_rate, UINT8_T *pdiff_trigger, UINT8_T *limit48v, UINT8_T *disable_prot)
 Get hardware configuration. More...
 
ERRCODE_T api_set_pulsar_ipaddr (UINT8_T port, const char *ip_addr, const char *subnet, const char *gateway)
 Set Pulsar IP address. More...
 
ERRCODE_T api_get_errors (UINT8_T port, INT16_T *err, UINT8_T *totalErrors)
 Reads the oldest posted error. More...
 
int api_connected_device (UINT8_T port)
 Gets the type of device on the given port. More...
 
ERRCODE_T api_get_mac (UINT8_T port, UINT8_T *mac)
 
ERRCODE_T api_set_mac (UINT8_T port, UINT8_T *mac)
 
ERRCODE_T api_get_manufacturing_mac (UINT8_T port, UINT8_T *mac)
 
ERRCODE_T api_get_pulsar_addrs (UINT32_T *addrs, UINT16_T max_addrs, UINT16_T *num_found)
 Find pulsar devices on all attached network adapters. More...
 

Detailed Description

This module contains external definitions for the High Level User Application Programming Interface DLL functions in the Pulsar320 and Pulsar320E projects.

Contains confidential and proprietary information which may not be copied, disclosed or used by others except as expressly authorized in writing by Advanced Illumination.

External definitions for the High Level User Application Programming Interface

Written for:
Advanced Illumination, Inc.
440 State Garage Road
Rochester, VT 05767
http://advancedillumination.com

Contacts:
John Thrailkill
Phone: (802) 767-3830
FAX: (802) 767-3831
jthra.nosp@m.ilki.nosp@m.ll@ad.nosp@m.vanc.nosp@m.edill.nosp@m.umin.nosp@m.ation.nosp@m..com

Written by:
Rob Macklin
Microprocessor Designs, Inc.
65 Longmeadow Drive
PO Box 160
Shelburne, VT 05482
http://www.updesigns.com

Revision
4

Enumeration Type Documentation

◆ anonymous enum

anonymous enum

Define the trigger input identifiers used with the API interface.

Enumerator
API_TRIG_NONE 

No trigger input.

API_TRIG_1 

Trigger input 1.

API_TRIG_2 

Trigger input 2.

◆ API_MODE_T

enum API_MODE_T

Define possible operating modes.

Enumerator
API_MODE_PULSED 

Pulse mode.

API_MODE_REPEAT 

Repeat mode, same as pulsed in 320E.

API_MODE_TIMING_BYPASS 

Used for Continuous mode (with 1,000,000us pulsewidth)

API_MODE_INTERNAL_TRIGGER 

Used for test mode (10Hz internal trigger)

API_NUM_MODE 

Number of enum entries (do not use as mode)

Function Documentation

◆ api_calc_led_temp()

ERRCODE_T api_calc_led_temp ( UINT8_T  port,
UINT8_T  ch,
UINT32_T  width,
FLOAT32_T  current,
FLOAT32_T *  temp 
)

Calculates the expected LED junction temperature based on the information stored in the lighthead data structure and the width and current information passed.

Parameters
portIdentifier for device
chChannel to compute LED temperature
widthPulse width in microseconds
currentPulse current in amps
[out]tempLocation to store calculated temperature
Returns
Zero if successful, error code otherwise

◆ api_calc_max_current()

ERRCODE_T api_calc_max_current ( UINT8_T  port,
UINT8_T  ch,
UINT32_T  width,
FLOAT32_T *  current 
)

Calculates the maximum pulse current for the selected channel based on the information stored in the lighthead data structure and the width information passed.

Parameters
portIdentifier for device
chChannel to compute LED temperature
widthPulse width in microseconds
[out]currentMaximum pulse current in amps
Returns
Zero if successful, error code otherwise

◆ api_calc_max_freq()

ERRCODE_T api_calc_max_freq ( UINT8_T  port,
UINT8_T  ch,
UINT32_T  width,
FLOAT32_T  current,
UINT16_T *  freq 
)

Calculates the maximum frequency allowed for a given width and current.

This function computes maximum frequency based on the maximum power of the power supply and also from the LED cooling equations. The lower value is returned.

Parameters
portIdentifier for device
chChannel to compute maximum frequency
widthPulse width in microseconds
currentPulse current in amps
[out]freqLocation to store calculated frequency
Returns
Zero if successful, error code otherwise

◆ api_calc_max_width()

ERRCODE_T api_calc_max_width ( UINT8_T  port,
UINT8_T  ch,
FLOAT32_T  current,
UINT32_T *  width 
)

Calculates the maximum pulse width for the selected channel based on the information stored in the lighthead data structure and the current information passed.

Parameters
portIdentifier for device
chChannel to compute LED temperature
currentPulse current in amps
[out]widthMaximum pulse width in microseconds
Returns
Zero if successful, error code otherwise

◆ api_calc_supply_voltage()

ERRCODE_T api_calc_supply_voltage ( UINT8_T  port,
UINT8_T  ch,
UINT32_T  width,
FLOAT32_T  current,
FLOAT32_T *  voltage 
)

Calculates the required supply voltage for a given width and current.

Parameters
portIdentifier for device
chChannel to compute required supply voltage
widthPulse width in microseconds
currentPulse current in amps
[out]voltageLocation to store calculated voltage
Returns
Zero if successful, error code otherwise

◆ api_connect()

ERRCODE_T api_connect ( UINT8_T  port,
const INT8_T *  product_name,
const INT8_T *  ip_addr 
)

Initializes the connection to a specific Pulsar.

See also
api_init for USB connections
Parameters
portIdentifier for device
product_nameName of USB device to open
ip_addrIP address of device to open
Returns
Zero if successful, error code otherwise

◆ api_connected_device()

int api_connected_device ( UINT8_T  port)

Gets the type of device on the given port.

Parameters
portCommunication port of the device
Returns
Zero if none connected, 1 for Pulsar 320, 2 for Pulsar 320E

◆ api_get_channel_config()

ERRCODE_T api_get_channel_config ( UINT8_T  port,
UINT8_T  chan,
UINT8_T  type,
API_CHAN_CONFIG_STRUCT_T config_data 
)

Gets the configuration data for one drive channel.

Parameters
portIdentifier for device
chanIdentifier for drive channel
typeIdentifier for which data to get
[out]config_dataActive channel configuration data
Returns
Zero if successful, error code otherwise

◆ api_get_configuration()

ERRCODE_T api_get_configuration ( UINT8_T  port,
UINT8_T *  pslew_rate,
UINT8_T *  pdiff_trigger,
UINT8_T *  limit48v,
UINT8_T *  disable_prot 
)

Get hardware configuration.

Parameters
portCommunication port to use
[out]slew_rateSlew rate (array, one for each channel)
[out]diff_triggerDifferential trigger (0 or 1) (array, one for each channel)
[out]limit48vLimit output to 48v
[out]disable_protDisable protection
Returns
Zero if successful, error code otherwise

◆ api_get_dll_full_version()

UINT32_T api_get_dll_full_version ( void  )

Returns the full version number of this software.

Each byte in the integer encodes a different part of the version number

  • Byte 0 (highest): MAJOR
  • Byte 1: MINOR
  • Byte 2: PATCH
  • Byte 3: Build (usually 0)
Returns
Big-endian unsigned integer encoding the version number

◆ api_get_dll_version()

UINT16_T api_get_dll_version ( void  )

Returns the current version number of this software.

Returns
High byte is major version number, Low byte is minor version number

◆ api_get_error_name()

ERRCODE_T api_get_error_name ( ERRCODE_T  ecode,
char *  nameptr,
UINT16_T  namelen 
)

Returns the name of the error associated with the code.

Parameters
[in]ecodeCode to be looked up
[out]nameptrLocation to place name string
[in]namelenMaximum length of name string
Returns
Zero if successful, error code otherwise

◆ api_get_error_text()

ERRCODE_T api_get_error_text ( ERRCODE_T  ecode,
char *  textptr,
UINT16_T  textlen 
)

Returns the text description of the error associated with the code.

Parameters
ecodeCode to be looked up
[out]textptrLocation to place text description string
textlenMaximum length of text description string
Returns
Zero if successful, error code otherwise

◆ api_get_errors()

ERRCODE_T api_get_errors ( UINT8_T  port,
INT16_T *  err,
UINT8_T *  totalErrors 
)

Reads the oldest posted error.

Parameters
portCommunication port to use
[out]errThe oldest posted error in the device
[out]totalErrorsThe number of errors remaining to read
Returns
PULSAR_API

◆ api_get_light_data()

ERRCODE_T api_get_light_data ( UINT8_T  port,
UINT8_T *  sig_model,
UINT8_T *  sig1_id,
char *  sig2_pn,
char *  sig2_sn 
)

Gathers information regarding the lighthead type.

Parameters
portIdentifier for device
[out]sig_model1 - Signatech I, 2 - Signatech II, 0 - Unknown
[out]sig1_idSet for Signatech I lightheads
[out]sig2_pnSet to part number string for Signatech II
[out]sig2_snSet to serial number of Signatech 2 lighthead
Returns
Zero if successful, error code otherwise

◆ api_get_light_data2()

ERRCODE_T api_get_light_data2 ( UINT8_T  port,
UINT8_T  channel,
char *  sig2_pn 
)

Get Signatech II lighthead part and serial number.

Parameters
portIdentifier for device
channelOutput channel to read (only valid for Pulsar 320E)
[out]sig2_pnPart number of Signatech 2 lighthead
Returns
Zero if successful, error code otherwise.

◆ api_get_pulsar_addrs()

ERRCODE_T api_get_pulsar_addrs ( UINT32_T *  addrs,
UINT16_T  max_addrs,
UINT16_T *  num_found 
)

Find pulsar devices on all attached network adapters.

Parameters
addrsArray of UINT32_Ts to fill with found IP addresses (in network byte order).
max_addrsMaximum number of addresses to find (size of the array)
num_foundActual number of addresses found
Returns
Zero if successful, error code otherwise

◆ api_get_pulsar_ipaddr()

ERRCODE_T api_get_pulsar_ipaddr ( UINT8_T  port,
INT8_T *  ip_addr,
INT8_T *  subnet,
INT8_T *  gateway,
INT8_T *  mac_addr 
)

Reads iip configuration settings from the device Each string can be up to 32 characters long.

Get Pulsar IP address.

Parameters
[in]portIdentifier for device
[out]ip_addrIP Address
[out]subnetSubnet Mask
[out]gatewayGateway
[out]mac_addrHardware MAC address
Returns
Zero if successful, error code otherwise
Parameters
portCommunication port to use
[out]ip_addrIP address
[out]subnetSubnet mask
[out]gatewayGateway address
[out]mac_addrMAC address
Returns
Zero if successful, error code otherwise

◆ api_get_pulsar_version()

ERRCODE_T api_get_pulsar_version ( UINT8_T  port,
INT8_T *  fw_version,
INT8_T *  hw_version,
INT8_T *  serial_num 
)

Reads firmware version, hardware version, and serial number Each string can be up to 32 characters long.

Parameters
[in]portIdentifier for device
[out]fw_versionFirmware version
[out]hw_versionHardware version
[out]serial_numSerial number
Returns
Zero if successful, error code otherwise

◆ api_get_status()

ERRCODE_T api_get_status ( UINT8_T  port)

Reads status information from the device.

Parameters
portIdentifier for device
Returns
Zero if successful, error code otherwise

◆ api_get_stored_data()

ERRCODE_T api_get_stored_data ( UINT8_T  port,
UINT8_T *  data,
UINT8_T  len 
)

Reads a block of Ai defined data from EEPROM.

Parameters
portIdentifier for device
lenLength of data block to read
[out]dataPointer to data block to be written
Returns
Zero if successful, error code otherwise

◆ api_get_user_data()

ERRCODE_T api_get_user_data ( UINT8_T  port,
UINT16_T *  rotary,
UINT8_T *  dip,
UINT8_T *  trigger,
UINT8_T *  connect,
UINT8_T *  supply,
UINT8_T *  expansion 
)

Gathers various information about the operating state of the Pulsar.

Parameters
portIdentifier for device
[out]rotaryValue on rotary switches
[out]dipValue on DIP switches
[out]triggerState of trigger inputs
[out]connectCommunication connection status
[out]supplyPower supply status
[out]expansionExpansion status
Returns
Zero if successful, error code otherwise
Note
A NULL can be passed for any data values not needed

◆ api_init()

ERRCODE_T api_init ( UINT8_T  port,
const INT8_T *  product_name,
const INT8_T *  serial_num 
)

Initializes the connection to a specific Pulsar.

Warning
FOR USB CONNECTIONS ONLY - SEE api_connect FOR TCP/IP CONNECTIONS
See also
api_connect
Parameters
portIdentifier for device
product_nameName of USB device to open
serial_numSerial number of device to open (or NULL)
Returns
Zero if successful, error code otherwise

◆ api_measure_drive_current()

ERRCODE_T api_measure_drive_current ( UINT8_T  port,
UINT8_T  ch,
FLOAT32_T *  current 
)

Measures the drive current of the selected drive channel.

This function can be used in either pulse or continuous modes.

Parameters
portIdentifier for device
chChannel to measure pulse current
[out]currentLocation to store measured pulse current
Returns
Zero if successful, error code otherwise

◆ api_measure_voltage()

ERRCODE_T api_measure_voltage ( UINT8_T  port,
UINT8_T  id,
FLOAT32_T *  voltage 
)

Measures the voltage of one of the signals monitored by the Pulsar.

Parameters
portIdentifier for device
idIdentifier for desired voltage to measure
[out]voltageLocation to store measured voltage
Returns
Zero if successful, error code otherwise

◆ api_run_diags()

ERRCODE_T api_run_diags ( UINT8_T  port,
UINT8_T  test_num 
)

Runs one or all of the built in diagnostics.

Parameters
portIdentifier for device
test_numDesired test number or FF for all
Returns
Zero if successful, error code otherwise

◆ api_set_channel_config()

ERRCODE_T api_set_channel_config ( UINT8_T  port,
UINT8_T  chan,
UINT8_T  type,
API_CHAN_CONFIG_STRUCT_T config_data 
)

Sets the configuration data for one drive channel.

Parameters
portIdentifier for device
chanIdentifier for drive channel
typeIdentifier for which data to get
API_CHAN_CONFIG_STRUCT_T* config_data New channel configuration data
Returns
Zero if successful, error code otherwise

◆ api_set_channel_config_nochecks()

ERRCODE_T api_set_channel_config_nochecks ( UINT8_T  port,
UINT8_T  chan,
UINT8_T  type,
API_CHAN_CONFIG_STRUCT_T config_data 
)

Sets the configuration data for one drive channel.

Warning
Unlike api_set_channel_config API call, the "nochecks" function does not verify the settings. This could result it improper channel settings or configuration that could break hardware or blow flash bulbs.
Parameters
portIdentifier for device
chanIdentifier for drive channel
typeIdentifier for which data to get
API_CHAN_CONFIG_STRUCT_T* config_data New channel configuration data
Returns
Zero if successful, error code otherwise

◆ api_set_configuration()

ERRCODE_T api_set_configuration ( UINT8_T  port,
UINT8_T *  slew_rate,
UINT8_T *  diff_trigger,
UINT8_T  limit48v,
UINT8_T  disable_prot 
)

Set hardware configuration.

Parameters
portCommunication port to use
[in]slew_rateSlew rate (array, one for each channel)
[in]diff_triggerDifferential trigger (0 or 1) (array, one for each channel)
[in]limit48vLimit output to 48v
[in]disable_protDisable protection
Returns
Zero if successful, error code otherwise

◆ api_set_pulsar_ipaddr()

ERRCODE_T api_set_pulsar_ipaddr ( UINT8_T  port,
const char *  ip_addr,
const char *  subnet,
const char *  gateway 
)

Set Pulsar IP address.

Parameters
portCommunication port to use
[in]ip_addrIP address
[in]subnetSubnet mask
[in]gatewayGateway address
Returns
Zero if successful, error code otherwise

◆ api_set_stored_data()

ERRCODE_T api_set_stored_data ( UINT8_T  port,
UINT8_T *  data,
UINT8_T  len 
)

Saves a block of Ai defined data to EEPROM.

Parameters
portIdentifier for device
dataPointer to data block to be written
lenLength of data block to be written
Returns
Zero if successful, error code otherwise

◆ api_shutdown()

ERRCODE_T api_shutdown ( UINT8_T  port)

Shuts down the connection to a specific Pulsar.

Parameters
portCommunication port to use
Returns
Zero if successful, error code otherwise

◆ api_trigger()

ERRCODE_T api_trigger ( UINT8_T  port,
UINT8_T  trig 
)

Generates a software trigger on the selected trigger channel.

Parameters
portIdentifier for device
trigTrigger to activate
Returns
Zero if successful, error code otherwise