Modules

 Object-Oriented SeaMAX Modbus Interface
 
 Functional SeaMAX Modbus Interface
 

Classes

struct  PIO48_config_s
 48 Bit pio configuration. This struct is contained within the SeaMAX_PIO_ioctl_s struct. It is used whenever retrieving or setting port direction on a PIO device with 48 bits of I/O. More...
 
struct  PIO96_config_s
 96 Bit pio configuration. This struct is contained within the SeaMAX_PIO_ioctl_s struct. It is used whenever retrieving or setting port direction on a PIO device with 96 bits of I/O. More...
 
struct  seaio_ioctl_address_s
 This struct is used to set the address of a particular device. In this way, it becomes unnecessary to manually turn the screw terminal to configure a particular SeaIO device. It also allows for more devices than the physically selectable 15 addresses. More...
 
struct  seaio_ioctl_comms_s
 Communication parameters (desired) struct. This struct can be used to set a desired communication configuration. Note that you must first call get params before you attempt to set params, or it will fail. More...
 
struct  seaio_ioctl_get_params_s
 Communication parameters (current) struct. This struct can be used to store the current communication parameters. Note that you will have call get params before you may set a configuration, or it will fail. More...
 
struct  SeaMAX_PIO_ioctl_s
 PIO data/setup struct. This struct can be used to read data from a PIO device, or configure a PIO device. More...
 
struct  seaio_ioctl_ext_config
 PIO data/setup struct. This struct can be used to read data from a PIO device, or configure a PIO device. More...
 
struct  seaio_ioctl_s
 The IOCTL struct used in the majority of the IOCTL calls. Every call except the three involving A/D and D/A converters use this struct. This struct is actually the union of several smaller structs, so that it can be used multiple times. More...
 
struct  adda_config
 The ADDA data struct used in the ADDA ioctl calls. Contains information about device configuration. More...
 
struct  adda_ext_config
 Data struct returned by get ext adda ioctl. Contains information about the physical jumper configuration of the device. More...
 

Typedefs

typedef struct PIO48_config_s PIO48_config_s
 48 Bit pio configuration. This struct is contained within the SeaMAX_PIO_ioctl_s struct. It is used whenever retrieving or setting port direction on a PIO device with 48 bits of I/O.
 
typedef struct PIO96_config_s PIO96_config_s
 96 Bit pio configuration. This struct is contained within the SeaMAX_PIO_ioctl_s struct. It is used whenever retrieving or setting port direction on a PIO device with 96 bits of I/O.
 
typedef struct seaio_ioctl_address_s seaio_ioctl_address_s
 This struct is used to set the address of a particular device. In this way, it becomes unnecessary to manually turn the screw terminal to configure a particular SeaIO device. It also allows for more devices than the physically selectable 15 addresses.
 
typedef struct seaio_ioctl_comms_s seaio_ioctl_comms_s
 Communication parameters (desired) struct. This struct can be used to set a desired communication configuration. Note that you must first call get params before you attempt to set params, or it will fail.
 
typedef struct seaio_ioctl_get_params_s seaio_ioctl_get_params_s
 Communication parameters (current) struct. This struct can be used to store the current communication parameters. Note that you will have call get params before you may set a configuration, or it will fail.
 
typedef struct SeaMAX_PIO_ioctl_s SeaMAX_PIO_ioctl_s
 PIO data/setup struct. This struct can be used to read data from a PIO device, or configure a PIO device.
 
typedef struct seaio_ioctl_ext_config seaio_ioctl_ext_config
 PIO data/setup struct. This struct can be used to read data from a PIO device, or configure a PIO device.
 
typedef struct seaio_ioctl_s seaio_ioctl_s
 The IOCTL struct used in the majority of the IOCTL calls. Every call except the three involving A/D and D/A converters use this struct. This struct is actually the union of several smaller structs, so that it can be used multiple times.
 
typedef struct adda_config adda_config
 The ADDA data struct used in the ADDA ioctl calls. Contains information about device configuration.
 
typedef struct adda_ext_config adda_ext_config
 Data struct returned by get ext adda ioctl. Contains information about the physical jumper configuration of the device.
 
typedef long SeaMaxLin
 
typedef int HANDLE
 
typedef unsigned char slave_address_t
 
typedef unsigned short address_loc_t
 
typedef unsigned short address_range_t
 

Enumerations

enum  seaio_mode_t { NO_CONNECT = 0, MODBUS_RTU = 1, MODBUS_TCP = 2, FTDI_DIRECT = 3 }
 The module connection type. Currently there is only support for RTU and TCP type connections. More...
 
enum  baud_rates_t {
  BRNONE = 0, BR1200 = 1, BR2400 = 2, BR4800 = 3,
  BR9600 = 4, BR14400 = 5, BR19200 = 6, BR28800 = 7,
  BR38400 = 8, BR57600 = 9, BR115200 = 10
}
 The current baud rate used by a RTU type module. If the module is TCP type, then BR9600, the default, will be used. Note these are not the same values used by the termios library. More...
 
enum  parity_t { P_NONE = 0, P_ODD = 1, P_EVEN = 2 }
 The currently used parity. Parity is a quick and simple method of checking for errors. It doesn't work all the time, but it is very simple to implement. More...
 
enum  seaio_type_t {
  COILS = 1, D_INPUTS = 2, HOLDINGREG = 3, INPUTREG = 4,
  SETUPREG = 5, SEAMAXPIO = 6
}
 The type of read / write to preform. Note that not all types can be written. For example an attempt to write to D_INPUTS or INPUTREG would cause an EINVAL error. Also you can not directly write to SETUPREGS, you must use an appropriate Ioctl. More...
 
enum  IOCTL_t {
  IOCTL_READ_COMM_PARAM = 1, IOCTL_SET_ADDRESS = 2, IOCTL_SET_COMM_PARAM = 3, IOCTL_GET_PIO = 4,
  IOCTL_SET_PIO = 5, IOCTL_GET_ADDA_CONFIG = 6, IOCTL_SET_ADDA_CONFIG = 7, IOCTL_GET_EXT_CONFIG = 8,
  IOCTL_GET_ADDA_EXT_CONFIG = 9
}
 The type of IOCTL operation desired. Read the manual carefully when using these. There are some specific methods that must be followed to use correctly. More...
 
enum  channel_range_type { ZERO_TO_FIVE = 0, PLS_MIN_FIVE = 1, ZERO_TO_TEN = 2, PLS_MIN_TEN = 3 }
 ADDA conversion range configuration type. This is the range of voltages that the A/D will convert into values from 0x000 to 0xFFF (0-4095). Plus to minus conversions do use a sign bit, so 4095 is not necessarily the highest value. More...
 
enum  channel_mode_type { SINGLE_ENDED = 0, DIFFERENTIAL = 1, CURRENT_LOOP = 2 }
 
enum  ad_reference_type {
  ANALOG_OFFSET = 0, GND_OFFSET = 1, AD_REF_OFFSET = 2, DA_CHANNEL_1 = 4,
  DA_CHANNEL_2 = 8
}
 ADDA reference type configuration. This controls the mux that is in charge of input to the single A/D chip on an A/D capable device. This provides some small A/D diagnostics if you desire to use them. More...
 

Detailed Description

The SeaMAX API consists of the functions outline below, and provides an interface for construction, transmission, and reception of Modbus RTU and TCP commands. For more information, click a function name below for detailed information on function use, parameter types, and return codes.

Note
Not every function below may apply to your specific Sealevel I/O device. Refer to the modbus breakdown.
 
 
Generated on Tue Sep 19 2017.