Nodka_GetPwmParams


Gets parameters of the light controller.

Syntax

C++
Python
 
def Nodka_GetPwmParams(
	state: Nodka_State,
	/,
	*,
	inServerPort: int | None = None,
	inDeviceConfigPath: str | None = None,
	inDeviceLightControllerPort: int | None = None,
	inDevId: int = 0,
	inChIdx: NodkaLightControlChannel = NodkaLightControlChannel.LightControlCh0,
	inTimeout: int = 100
)
-> (
	outPwmMode: NodkaPwmMode,
	outPwmValue: int,
	outPwmHoldingTime: int,
	outPwmOnOff: int
)

Parameters

Name Type Range Default Description
Input will be modified ioState Nodka_State
Input value inServerPort int | None 1 - 65535 None Port of NodkaServer service.
Input value inDeviceConfigPath str | None None Path to nkio_config.ini file with I/O configuration.
Input value inDeviceLightControllerPort int | None 1 - None COM port used by the light controller (if supported by the device).
Input value inDevId int 0 - 255 0 ID of the device (0x01 for the light controller).
Input value inChIdx NodkaLightControlChannel NodkaLightControlChannel.LightControlCh0 Light controller channel ID.
Input value inTimeout int 0 - 100 Timeout for the callback function.
Output value outPwmMode NodkaPwmMode Trigger mode of the light controller.
Output value outPwmValue int Brightness level of the light controller.
Output value outPwmHoldingTime int Duration of the 'on' state of the light controller (see also: Nodka_SetHoldingTimeUnit).
Output value outPwmOnOff int Parameter to turn the light on or off.