ngcppComParam.c File Reference

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>
#include <errno.h>
#include <ngc/core/ngcppInt.h>
#include <ngc/core/ngcppCom.h>

Macros
#define	ngcppPARAM_MAX_CON   256

Functions
int	ngcppGetParamSetup (ngcpp_link_t lnk, int *numParam, ngcppPARAM_NAMES paramName, ngcppPARAM_VALUES paramBuf, char *erms)
int	ngcppGetParamType (ngcpp_link_t lnk, const char *paramName, int *type, char *erms)
int	ngcppSetParam (ngcpp_link_t lnk, const char *paramName, int value, char *erms)
int	ngcppSetParamBuf (ngcpp_link_t lnk, int *paramBuf, char *erms)
int	ngcppGetParam (ngcpp_link_t lnk, const char *paramName, int *value, char *erms)
int	ngcppGetParamBuf (ngcpp_link_t lnk, int *paramBuf, char *erms)
int	ngcppParamSync (ngcpp_link_t lnk, int timeout, char *erms)
int	ngcppSetChipOffset (ngcpp_link_t lnk, int startX, int startY, char *erms)
int	ngcppChanSelect (ngcpp_link_t lnk, int chan, char *erms)
int	ngcppVerbose (ngcpp_link_t lnk, int vflag, char *erms)
int	ngcppSendDynCmd (ngcpp_link_t lnk, int cmdCode, int timeout, char *erms)
int	ngcppExecUsrCmd (ngcpp_link_t lnk, const char *usrCommand, char *usrReply, char *erms)

Variables
ngcpp_cmd_t	ngcppCommand
ngcpp_rep_t	ngcppReply
ngcpp_link_cfg_t *	ngcppLink [FD_SETSIZE]

Detailed Description

Copyright

SPDX-FileCopyrightText: 2026 European Southern Observatory (ESO) SPDX-License-Identifier: LGPL-3.0-only

Macro Definition Documentation

ngcppPARAM_MAX_CON

#define ngcppPARAM_MAX_CON   256

Function Documentation

ngcppChanSelect()

int ngcppChanSelect	(	ngcpp_link_t	link,
		int	chan,
		char *	erms )

Select the DMA interface channel in use.

ngcppExecUsrCmd()

int ngcppExecUsrCmd	(	ngcpp_link_t	link,
		const char *	usrCommand,
		char *	usrReply,
		char *	erms )

Executes an external user command handler at the acquisition process. The command/reply string are passed unchecked.

ngcppGetParam()

int ngcppGetParam	(	ngcpp_link_t	link,
		const char *	paramName,
		int *	value,
		char *	erms )

Gets the value of paramater definde by paramName. The parameter names are retrieved with ngcppGetParamSetup().

ngcppGetParamBuf()

int ngcppGetParamBuf	(	ngcpp_link_t	link,
		int *	paramBuf,
		char *	erms )

Receive a parameter buffer from the command interpreter.

ngcppGetParamSetup()

int ngcppGetParamSetup	(	ngcpp_link_t	link,
		int *	numParame,
		ngcppPARAM_NAMES	paramName,
		ngcppPARAM_VALUES	paramBuf,
		char *	erms )

Receive the currently loaded parameter setup from the ngcpp command interpreter.

ngcppGetParamType()

int ngcppGetParamType	(	ngcpp_link_t	link,
		const char *	paramName,
		int *	type,
		char *	erms )

Return the type of the parameter.

ngcppParamSync()

int ngcppParamSync	(	ngcpp_link_t	link,
		int	timeout,
		char *	erms )

If parameters are changed, their values are overtaken synchronously with ngcppParamSync(). If this function is called, before the previous synchronization is actually done, the function will block until the specified timeout. The timeout is given in seconds. A value of zero specifies "no timeout".

ngcppSendDynCmd()

int ngcppSendDynCmd	(	ngcpp_link_t	link,
		int	cmdCode,
		int	timeout,
		char *	erms )

Send dynamic command.

ngcppSetChipOffset()

int ngcppSetChipOffset	(	ngcpp_link_t	link,
		int	startX,
		int	startY,
		char *	erms )

Set the offset of the readout window within the chip (startX, startY start with 1).

ngcppSetParam()

int ngcppSetParam	(	ngcpp_link_t	link,
		const char *	paramName,
		int	value,
		char *	erms )

Sets the paramater paramName to the given value. The parameter names are retrieved with ngcppGetParamSetup().

ngcppSetParamBuf()

int ngcppSetParamBuf	(	ngcpp_link_t	link,
		int *	paramBuf,
		char *	erms )

Send a parameter buffer to the command interpreter.

ngcppVerbose()

int ngcppVerbose	(	ngcpp_link_t	link,
		int	vflag,
		char *	erms )

Switches verbose mode off if vflag is zero, otherwise verbose mode is switched on.

Variable Documentation

ngcppCommand

ngcpp_cmd_t ngcppCommand

extern

ngcppLink

ngcpp_link_cfg_t* ngcppLink[FD_SETSIZE]

extern

ngcppReply

ngcpp_rep_t ngcppReply

extern