Programming Reference:NatusADC - Revision history

Wengelhardt at 16:06, 16 September 2024

2024-09-16T16:06:09Z

← Older revision		Revision as of 16:06, 16 September 2024
Line 1:		Line 1:
			''This page goes in-depth about the possible Natus commands. For information on the Natus implementation with BCI2000, refer to the [[Contributions:NatusADC\|NatusADC page]].''

	NatusADC module has 3 main classes - NatusPackageInterface, NatusDataServer and NatusClient. The overview of the NatusADC working is shown in the image below.		NatusADC module has 3 main classes - NatusPackageInterface, NatusDataServer and NatusClient. The overview of the NatusADC working is shown in the image below.
	[[File:Prog_Ref_NatusADC_NatusWorking.png\|center\|800px\|Overview of NatusADC working]]		[[File:Prog_Ref_NatusADC_NatusWorking.png\|center\|800px\|Overview of NatusADC working]]

Madamek2 at 20:29, 10 November 2021

2021-11-10T20:29:57Z

← Older revision		Revision as of 20:29, 10 November 2021
Line 10:		Line 10:

	== NatusPackageInterface ==		== NatusPackageInterface ==
	This class handles the communication between the server/device and the client. It should be included with both - NatusDataServer and NatusClient Class. The class performs the following functions -constructing TCP and UDP packets, sending the packets over TCP/UDP port, receiving packets over TCP/UDP Port, reconstructing the data from the packets and listening for connections on device/server-side. ~~''Note - The file limits the maximum number of channels for a device (stored in MAX_NUM_CHANNELS in NatusPackageInterface.h) to 100.''~~		This class handles the communication between the server/device and the client. It should be included with both - NatusDataServer and NatusClient Class. The class performs the following functions -constructing TCP and UDP packets, sending the packets over TCP/UDP port, receiving packets over TCP/UDP Port, reconstructing the data from the packets and listening for connections on device/server-side.
	<br/>		<br/>
	The format of the packets constructed along with each field size is as follows:		The format of the packets constructed along with each field size is as follows:

Madamek2: /* NatusPackageInterface */

2021-11-10T20:22:07Z

NatusPackageInterface

@@ Line 10: / Line 10: @@
 == NatusPackageInterface ==
-This class handles the communication between the server/device and the client. It should be included with both - NatusDataServer and NatusClient Class. The class performs the following functions -constructing TCP and UDP packets, calculating the CRC of a packet and checking the CRC on the receiving side, sending the packets over TCP/UDP port, receiving packets over TCP/UDP Port, reconstructing the data from the packets and listening for connections on device/server-side. ''Note - The file limits the maximum number of channels for a device (stored in MAX_NUM_CHANNELS in NatusPackageInterface.h) to 100.''
+This class handles the communication between the server/device and the client. It should be included with both - NatusDataServer and NatusClient Class. The class performs the following functions -constructing TCP and UDP packets, sending the packets over TCP/UDP port, receiving packets over TCP/UDP Port, reconstructing the data from the packets and listening for connections on device/server-side. ''Note - The file limits the maximum number of channels for a device (stored in MAX_NUM_CHANNELS in NatusPackageInterface.h) to 100.''
 <br/>
 The format of the packets constructed along with each field size is as follows:
-[[File:Prog_Ref_NatusADC_Packet_format.png|center|600px|Packet format]]
 === TCP Commands ===
@@ Line 67: / Line 82: @@
 * Return Value: NULL
 <u>Note:</u> The packet format for this command is as follows:
-[[File:Prog_Ref_NatusADC_CMD_ERR.png|center|Command CMD_ERR packet format.]]
+{| class="wikitable"
 === UDP Commands ===

Dashmeetkaur: /* NatusClient */

2019-07-29T20:59:21Z

NatusClient

← Older revision		Revision as of 20:59, 29 July 2019
Line 116:		Line 116:
	== NatusClient ==		== NatusClient ==
	This class handles the client-side processing. It connects with the server/device, gets data from the operator module of the NatusADC and sends it to the server/device. It uses various commands as described in the NatusDataServer to set different parameters. Another important function of this class 'interpolateMissingBlocks' linearly interpolates the missing UDP packets which contain the channel data values. Eg. <br/>		This class handles the client-side processing. It connects with the server/device, gets data from the operator module of the NatusADC and sends it to the server/device. It uses various commands as described in the NatusDataServer to set different parameters. Another important function of this class 'interpolateMissingBlocks' linearly interpolates the missing UDP packets which contain the channel data values. Eg. <br/>
	Consider the scenario where 1 block is sent ~~per packet and~~ decimation factor is 1. Suppose we received packet 1 and 3, packet 2 was lost. Data for packet 2 is interpolated as follows:		Consider the scenario where for a single channel with 1 sample per block, 1 block per packet is sent with decimation factor is 1. Suppose we received packet 1 and 3, packet 2 was lost. Data for packet 2 is interpolated as follows:
	<br/> Interpolation formula		<br/> Interpolation formula
	''Interpolated Value = ((Current Packet value – Previous Packet value) / (Current Packet Number – Previous Packet Number)) * (Interpolated Packet Number – Previous Packet Number) + Previous Packet Value''		''Interpolated Value = ((Current Packet value – Previous Packet value) / (Current Packet Number – Previous Packet Number)) * (Interpolated Packet Number – Previous Packet Number) + Previous Packet Value''

Dashmeetkaur at 20:56, 29 July 2019

2019-07-29T20:56:38Z

← Older revision		Revision as of 20:56, 29 July 2019
Line 3:		Line 3:

	NatusDataServer processes and sends signal from the device to the client application. A project named XLDataExportClient reads signals from the device and calls the NatusDataServer's functions to send the signal to the client. NatusClient is the client application within the BCI2000 that receives the signals and does the initial processing. NatusPackageInterface contains the implementation of data transfer protocol between serve/device and client and is used by NatusClient and NatusDataServer to communicate with each other over TCP and UDP. NatusDataServer and NatusPackageInterface are independent of the BCI2000 where as NatusClient relies on BCI2000.		NatusDataServer processes and sends signal from the device to the client application. A project named XLDataExportClient reads signals from the device and calls the NatusDataServer's functions to send the signal to the client. NatusClient is the client application within the BCI2000 that receives the signals and does the initial processing. NatusPackageInterface contains the implementation of data transfer protocol between serve/device and client and is used by NatusClient and NatusDataServer to communicate with each other over TCP and UDP. NatusDataServer and NatusPackageInterface are independent of the BCI2000 where as NatusClient relies on BCI2000.


			The below image explains the context in which packet, blocks, samples and channels are used in this project. A packet may have one or block, a block may have one or more samples and a sample contains values for all the channels.
			[[File:NatusPacketImage.png\|center\|600px\|Packet, block and samples relationship]]


	== NatusPackageInterface ==		== NatusPackageInterface ==

Dashmeetkaur: /* NatusPackageInterface */

2019-07-29T20:13:06Z

NatusPackageInterface

← Older revision		Revision as of 20:13, 29 July 2019
Line 17:		Line 17:
	* Return Value: returns payload		* Return Value: returns payload

	; CMD_GetInformation : To send the device information such as the number of channels and sampling rate to the client.		; CMD_GetInformation : To send the device information such as the number of channels and sampling rate to the client application.
	* Command Number: 0x02		* Command Number: 0x02
	* Parameters/Payload: NULL		* Parameters/Payload: NULL
	* Return Value: struct NatusDeviceInformation which contains the number of channels, sampling rate, and device identifier.		* Return Value: struct NatusDeviceInformation which contains the number of channels, sampling rate, and device identifier.

	; CMD_GetChannelNames : To send the channel names as set by the device to the client. If no channel names are set, NULL is sent.		; CMD_GetChannelNames : To send the channel names as set by the device to the client application. If no channel names are set, NULL is sent.
	* Command Number: 0x03		* Command Number: 0x03
	* Parameters/Payload: NULL		* Parameters/Payload: NULL
Line 65:		Line 65:

	=== UDP Commands ===		=== UDP Commands ===
	; CMD_StreamPackage: The command is sent from the server/device to the client when only 1 block per packet is sent.		; CMD_StreamPackage: The command is sent from the server/device to the client application when only 1 block per packet is sent.
	* Command Number: 0x11		* Command Number: 0x11
	* Parameters/Payload: Channel data of 1 block		* Parameters/Payload: Channel data of 1 block
	* Return Value: NULL		* Return Value: NULL

	; CMD_VariableSizeStreamPackage: The command is sent from the server/device to the client when more than 1 block per packet is sent.		; CMD_VariableSizeStreamPackage: The command is sent from the server/device to the client application when more than 1 block per packet is sent.
	* Command Number: 0x12		* Command Number: 0x12
	* Parameters/Payload: Channel data of more than 1 block (number of blocks as set by the CMD_SetBlockSize command)		* Parameters/Payload: Channel data of more than 1 block (number of blocks as set by the CMD_SetBlockSize command)

Dashmeetkaur: /* TCP Commands */

2019-07-29T20:10:34Z

TCP Commands

← Older revision		Revision as of 20:10, 29 July 2019
Line 37:		Line 37:
	* Return Value: NULL		* Return Value: NULL

	; CMD_SelectChannels : To send data only for the channels numbers mentioned in the payload		; CMD_SelectChannels : To send data only for the channels numbers mentioned in the payload. It corresponds to the SourceChList parameter.
	* Command Number: 0x20		* Command Number: 0x20
	* Parameters/Payload: a list of channel numbers separated by space and stored in a string		* Parameters/Payload: a list of channel numbers separated by space and stored in a string

Dashmeetkaur: /* TCP Commands */

2019-07-29T20:08:15Z

TCP Commands

← Older revision		Revision as of 20:08, 29 July 2019
Line 42:		Line 42:
	* Return Value: NULL		* Return Value: NULL

	; CMD_SetBlockSize : To set the number of blocks to send per packet.		; CMD_SetBlockSize : To set the number of blocks to send per packet. It corresponds to the SeverBlockSize parameter.
	* Command Number: 0x21		* Command Number: 0x21
	* Parameters/Payload: number of blocks to send per packet stored in uint32_t datatype.		* Parameters/Payload: number of blocks to send per packet stored in uint32_t datatype.
Line 63:		Line 63:
	<u>Note:</u> The packet format for this command is as follows:		<u>Note:</u> The packet format for this command is as follows:
	[[File:Prog_Ref_NatusADC_CMD_ERR.png\|center\|Command CMD_ERR packet format.]]		[[File:Prog_Ref_NatusADC_CMD_ERR.png\|center\|Command CMD_ERR packet format.]]

	=== UDP Commands ===		=== UDP Commands ===
	; CMD_StreamPackage: The command is sent from the server/device to the client when only 1 block per packet is sent.		; CMD_StreamPackage: The command is sent from the server/device to the client when only 1 block per packet is sent.

Dashmeetkaur at 19:58, 29 July 2019

2019-07-29T19:58:10Z

← Older revision		Revision as of 19:58, 29 July 2019
Line 1:		Line 1:
	NatusADC module has 3 main classes - NatusPackageInterface, NatusDataServer and NatusClient. The overview of the NatusADC working is shown in the image below.		NatusADC module has 3 main classes - NatusPackageInterface, NatusDataServer and NatusClient. The overview of the NatusADC working is shown in the image below.
	[[File:Prog_Ref_NatusADC_NatusWorking.png\|center\|800px\|Overview of NatusADC working]]		[[File:Prog_Ref_NatusADC_NatusWorking.png\|center\|800px\|Overview of NatusADC working]]

			NatusDataServer processes and sends signal from the device to the client application. A project named XLDataExportClient reads signals from the device and calls the NatusDataServer's functions to send the signal to the client. NatusClient is the client application within the BCI2000 that receives the signals and does the initial processing. NatusPackageInterface contains the implementation of data transfer protocol between serve/device and client and is used by NatusClient and NatusDataServer to communicate with each other over TCP and UDP. NatusDataServer and NatusPackageInterface are independent of the BCI2000 where as NatusClient relies on BCI2000.

	== NatusPackageInterface ==		== NatusPackageInterface ==

Dashmeetkaur at 21:19, 23 May 2019

2019-05-23T21:19:30Z

← Older revision		Revision as of 21:19, 23 May 2019
Line 60:		Line 60:
	* Return Value: NULL		* Return Value: NULL
	<u>Note:</u> The packet format for this command is as follows:		<u>Note:</u> The packet format for this command is as follows:
	[[File:Prog_Ref_NatusADC_CMD_ERR.png]]		[[File:Prog_Ref_NatusADC_CMD_ERR.png\|center\|Command CMD_ERR packet format.]]
	=== UDP Commands ===		=== UDP Commands ===
	; CMD_StreamPackage: The command is sent from the server/device to the client when only 1 block per packet is sent.		; CMD_StreamPackage: The command is sent from the server/device to the client when only 1 block per packet is sent.