FemtoScan Online SDK Documentation

The client SPM control interface library for FemtoScan Online; performs data aquisition and interpretation, provides interface for SPM control and parameters validation.

Messages sent over network in the following form:

 SPM 0x<msg>,<size>[[;<lparam#>] ...]\n<data>
 

where SPM is the message signature, 0x<msg> is message code in hexadecimal form, <size> is additional data size, following after newline character (\n) in raw binary format, <lparam#> are optional 32-bit integer values in signed decimal form, delimited with ";". For example, SPM_CLNT_CLIENT_CONNECT message for protocol version 0x407 with User Name set to "Filonov" will look as follows:

 SPM 0x101, 7; 1031
 Filonov
 

Author:

ATC

Version:

2.0.0.1

Entity	Type	Scope	Short Description
SPM_AUTH_STATUS_FAILED	macro	public	Authentification status.
SPM_AUTH_STATUS_GUEST	macro	public	Authentification status.
SPM_AUTH_STATUS_SUCCEEDED	macro	public	Authentification status.
SPM_CALIBR_MAX_ADC_NM	macro	public	AFM force calibration value selector.
SPM_CLNT_ADJUST_CALIBRATION	macro	public	Client to server, adjust calibration values.
SPM_CLNT_CLIENT_CONNECT	macro	public	Client to server, connect and check protocol version.
SPM_CLNT_GET_TIME_PARAMETERS	macro	public	Client to server, request server to send time parameters.
SPM_CLNT_MASTER_CONNECT	macro	public	Client to server, try to set master flag.
SPM_CLNT_MASTER_DISCONNECT	macro	public	Client to server, reset master flag.
SPM_CLNT_PASSWORD_AUTHENTICATE	macro	public	Client to server, password check responce.
SPM_CLNT_SET_USER_NAME	macro	public	Client to server, change client's name.
SPM_CLNT_SYNCHRONIZE	macro	public	Client to server, request server to synchronize client data about current device state.
SPM_PROTOCOL_VERSION	macro	public	Current protocol version.
SPM_RECEIVE_STRING	macro	public	Bidirectional, receive string message.
SPM_SET_PROCESS_STATE	macro	public	Bidirectional, set process state.
SPM_SET_SECURITY	macro	public	Bidirectional, set security options.
SPM_SET_VARIABLE	macro	public	Bidirectional, set variable value.
SPM_SIGNAL_EVENT	macro	public	Bidirectional, signal an event.
SPM_SRV_AUTH_SEED	macro	public	Server to client, set password ahentification seed.
SPM_SRV_AUTH_STATUS	macro	public	Server to client, reports authentification status.
SPM_SRV_DISCONNECT_CLIENT	macro	public	Server to client, asks to disconnect client from server.
SPM_SRV_END_UPDATE	macro	public	Server to client, finish update operation.
SPM_SRV_SERVER_VERSION	macro	public	Server to client, check server version.
SPM_SRV_SET_CLIENTS_LIST	macro	public	Server to client, set clients list.
SPM_SRV_SET_INTERFACE	macro	public	Server to client, set interface name.
SPM_SRV_SET_MASTER_STATE	macro	public	Server to client, change master flag.
SPM_SRV_SET_PROCESS	macro	public	Server to client, set process parameters.
SPM_SRV_SET_PROCESS_LIST	macro	public	Server to client, set available processes list.
SPM_SRV_SET_STREAM	macro	public	Server to client, set stream parameters.
SPM_SRV_SET_STREAM_DATA	macro	public	Server to client, set stream data.
SPM_SRV_SET_STREAM_LIST	macro	public	Server to client, set available streams list.
SPM_SRV_SET_TIME_PARAMETERS	macro	public	Server to client, set time parameters.
SPM_SRV_SET_VAR_LIST	macro	public	Server to client, set available variables list.
SPM_SRV_SET_VIDEO_DATA	macro	public	Server to client, set video data.
SPM_SRV_START_UPDATE	macro	public	Server to client, marks streams or variables for update.
SPM_UPDATE_STREAM	macro	public	undocumented

(C) Advanced Technologies Center, 2002-2006
For support contact us at fsdev@nanoscopy.net