Back to Aurora Vision Library website

You are here: Start » Function Reference » Hardware Support » Hikrobot » Hikrobot_GetLightParameters

Hikrobot_GetLightParameters


Header: ThirdPartySdk.h
Namespace: avl
Module: ThirdParty

Get light parameters.

Syntax

void avl::Hikrobot_GetLightParameters
(
	Hikrobot_State& ioState,
	atl::Optional<int> inDeviceID,
	avl::HikrobotLightPortNumber::Type inPortNumber,
	int& outLightValue,
	avl::HikrobotLightState::Type& outLightState,
	avl::HikrobotEdgeType::Type& outTriggerEdge,
	int& outDurationTime
)

Parameters

Name Type Range Default Description
Input will be modified ioState Hikrobot_State& Object used to maintain state of the function.
Input value inDeviceID Optional<int> 1 - NIL Device identification number - COM port number.
Input value inPortNumber HikrobotLightPortNumber::Type Device light port number reference.
Output value outLightValue int& Light brightness value [0-100].
Output value outLightState HikrobotLightState::Type& Light state after triggering.
Output value outTriggerEdge HikrobotEdgeType::Type& Trigger edge.
Output value outDurationTime int& Duration time [ms].

Remarks

This filter allows to get the parameters of a specific light port of the device. The parameters are brightness value, state after triggering, trigger edge and duration time.

I/O device driver software

This filter is intended to cooperate with a device using its vendor SDK. To be able to connect to a device, it is required to install Hikrobot VC4000 SDK.

Add DLL path to system environment variable is required.

In some computer models, digital inputs and outputs may operate in reverse logic (true is low signal level). Please check your device.

Recommended Hikrobot VC4000 SDK version for Aurora Vision Studio usage is 1.2.0.

Device identification

inDeviceID field can be used to pick one of multiple I/Os connected to computer. DeviceID can be set to:

  • COM port number - the number of the COM port used to communicate with the I/O.