Overview

The Nemesys V4 API is the RS232 API for newer Nemesys V4 devices such as Nemesys S and Nemesys M.

The example NemV4Test.cpp shows how to use the Namesys V4 API in an application.

+ Collaboration diagram for Nemesys V4 API:

Modules

 Analog, Digital I/O and Valve functions
 Functions for reading and writing the analog and digital inputs and outputs of Nemesys devices.
 
 Basic Motion Control Functions
 Basic low level motion control functions for execution of positioning tasks.
 
 Device State and Error Handling
 This group defines all required functions for reading and changing the device state and for reading the error state and error information.
 
 Dosing and pump control functions
 High level functions for pump control and execution of dosing tasks such as volume dosing, flow generation, aspiration and dispension.
 
 Force monitoring related functions
 This group contains functions for controlling the force monitoring, reading the force sensor and setting a custom force limit.
 
 Initialization and Configuration
 Functions for device initialization and syringe configuration.
 
 Unit Conversion
 This group contains functions for unit conversion between device specific position and velocity units into position and speed values in mm and mm/min and into volumes and flow rates in µl and ml/min.
 

Data Structures

struct  NemV4Scaling
 This data structure encapsulates data for analog input scaling. More...
 
struct  stNemesysV4
 Nemesys device object - required for Nemesys access and communication. More...
 

Typedefs

typedef struct stNemesysV4 TNemesysV4
 Nemesys device object - required for Nemesys access and communication.
 
typedef struct NemV4Scaling TNemV4Scaling
 This data structure encapsulates data for analog input scaling. More...
 

Enumerations

enum  eNemV4AnalogInput { NEM4_ANALOG_IN_EXTERNAL = 1, NEM4_ANALOG_IN_FORCE_SENSOR = 2 }
 Enumeration of Nemesys analog inputs. More...
 
enum  eNemV4ContiflowValvePositions { NEM4_CONTIFLOW_VALVE_CLOSED = 0, NEM4_CONTIFLOW_VALVE_PORT_1 = 1, NEM4_CONTIFLOW_VALVE_PORT_2 = 2, NEM4_CONTIFLOW_VALVE_OPEN = 3 }
 Enumeraion of external contiflow valve positions. More...
 
enum  eNemV4DigitalInput { NEM4_DIG_IN_EXTERNAL_1 = (1 << 16), NEM4_DIG_IN_EXTERNAL_2 = (1 << 17), NEM4_DIG_IN_EMCY_STOP = (1 << 18), NEM4_DIG_IN_SAFETY_STOP = (1 << 28) }
 Enumeration of Nemesys digital outputs. More...
 
enum  eNemV4DigitalOutput { NEM4_DIG_OUT_EXTERNAL_1 = (1 << 16), NEM4_DIG_OUT_EXTERNAL_2 = (1 << 17), NEM4_DIG_OUT_EXTERNAL_3 = (1 << 2), NEM4_DIG_OUT_BLUE_LED = (1 << 3) }
 Enumeration of all Nemesys digital outputs. More...
 
enum  eNemV4ProductType { NEMESYS_M = 6, NEMESYS_S = 7 }
 Enumeration of all supported Nemesys product types.
 

Typedef Documentation

typedef struct NemV4Scaling TNemV4Scaling

This data structure encapsulates data for analog input scaling.

The scaling is calculated with y = Factor * x + Offset.

Enumeration Type Documentation

Enumeration of Nemesys analog inputs.

Enumerator
NEM4_ANALOG_IN_EXTERNAL 

external analog input available on the Nemesys I/O interface

NEM4_ANALOG_IN_FORCE_SENSOR 

internal force sensor analog input

39 {
40  NEM4_ANALOG_IN_EXTERNAL = 1, ///< external analog input available on the Nemesys I/O interface
41  NEM4_ANALOG_IN_FORCE_SENSOR = 2 ///< internal force sensor analog input
42 };
internal force sensor analog input
Definition: nem4_rs232_api.h:41
external analog input available on the Nemesys I/O interface
Definition: nem4_rs232_api.h:40

Enumeraion of external contiflow valve positions.

Enumerator
NEM4_CONTIFLOW_VALVE_CLOSED 

closed position

NEM4_CONTIFLOW_VALVE_PORT_1 

port 1 open

NEM4_CONTIFLOW_VALVE_PORT_2 

port 2 open

NEM4_CONTIFLOW_VALVE_OPEN 

both ports open (not available for ball valves)

61 {
62  NEM4_CONTIFLOW_VALVE_CLOSED = 0,///< closed position
63  NEM4_CONTIFLOW_VALVE_PORT_1 = 1,///< port 1 open
64  NEM4_CONTIFLOW_VALVE_PORT_2 = 2,///< port 2 open
65  NEM4_CONTIFLOW_VALVE_OPEN = 3 ///< both ports open (not available for ball valves)
66 };
port 1 open
Definition: nem4_rs232_api.h:63
both ports open (not available for ball valves)
Definition: nem4_rs232_api.h:65
port 2 open
Definition: nem4_rs232_api.h:64
closed position
Definition: nem4_rs232_api.h:62

Enumeration of Nemesys digital outputs.

Enumerator
NEM4_DIG_IN_EXTERNAL_1 

Nemesys I/O interface digital input 1.

NEM4_DIG_IN_EXTERNAL_2 

Nemesys I/O interface digital input 2.

NEM4_DIG_IN_EMCY_STOP 

Nemesys I/O interface emergency stop input.

NEM4_DIG_IN_SAFETY_STOP 

Safety stop input - this input is set if force monitoring detects a too high force.

49 {
50  NEM4_DIG_IN_EXTERNAL_1 = (1 << 16),///< Nemesys I/O interface digital input 1
51  NEM4_DIG_IN_EXTERNAL_2 = (1 << 17),///< Nemesys I/O interface digital input 2
52  NEM4_DIG_IN_EMCY_STOP = (1 << 18),///< Nemesys I/O interface emergency stop input
53  NEM4_DIG_IN_SAFETY_STOP = (1 << 28)///< Safety stop input - this input is set if force monitoring detects a too high force
54 };
Nemesys I/O interface digital input 2.
Definition: nem4_rs232_api.h:51
Safety stop input - this input is set if force monitoring detects a too high force.
Definition: nem4_rs232_api.h:53
Nemesys I/O interface digital input 1.
Definition: nem4_rs232_api.h:50
Nemesys I/O interface emergency stop input.
Definition: nem4_rs232_api.h:52

Enumeration of all Nemesys digital outputs.

Enumerator
NEM4_DIG_OUT_EXTERNAL_1 

Nemesys I/O interface digital output 1.

NEM4_DIG_OUT_EXTERNAL_2 

Nemesys I/O interface digital output 2.

NEM4_DIG_OUT_EXTERNAL_3 

Nemesys I/O interface digital output 3.

NEM4_DIG_OUT_BLUE_LED 

Blue status LED.

83 {
84  NEM4_DIG_OUT_EXTERNAL_1 = (1 << 16),///< Nemesys I/O interface digital output 1
85  NEM4_DIG_OUT_EXTERNAL_2 = (1 << 17),///< Nemesys I/O interface digital output 2
86  NEM4_DIG_OUT_EXTERNAL_3 = (1 << 2), ///< Nemesys I/O interface digital output 3
87  NEM4_DIG_OUT_BLUE_LED = (1 << 3) ///< Blue status LED
88 };
Blue status LED.
Definition: nem4_rs232_api.h:87
Nemesys I/O interface digital output 3.
Definition: nem4_rs232_api.h:86
Nemesys I/O interface digital output 1.
Definition: nem4_rs232_api.h:84
Nemesys I/O interface digital output 2.
Definition: nem4_rs232_api.h:85