3.07.Data-Bell.h File Reference

Detailed Description

Author

http://www.zkteco.com

Date

2017-10-01

copyright:

Copyright 2017 ZKTECO CO., LTD. All Rights Reserved.

Note

Functions
VARIANT_BOOL	GetBellSchDataEx (LONG dwMachineNumber, LONG weekDay, LONG Index, LONG *Enable, LONG *hour, LONG *min, LONG *voice, LONG *way, LONG *InerBellDelay, LONG *ExtBellDelay)
VARIANT_BOOL	SetBellSchDataEx (LONG dwMachineNumber, LONG weekDay, LONG Index, LONG Enable, LONG hour, LONG min, LONG voice, LONG way, LONG InerBellDelay, LONG ExtBellDelay)
VARIANT_BOOL	GetDayBellSchCount (LONG dwMachineNumber, LONG *DayBellCnt)
VARIANT_BOOL	GetMaxBellIDInBellSchData (LONG dwMachineNumber, LONG *MaxBellID)
VARIANT_BOOL	ReadAllBellSchData (LONG dwMachineNumber)
VARIANT_BOOL	GetEachBellInfo (LONG dwMachineNumber, LONG *weekDay, LONG *Index, LONG *Enable, LONG *hour, LONG *min, LONG *voice, LONG *way, LONG *InerBellDelay, LONG *ExtBellDelay)

Function Documentation

GetBellSchDataEx()

VARIANT_BOOL GetBellSchDataEx	(	LONG	dwMachineNumber,
		LONG	weekDay,
		LONG	Index,
		LONG *	Enable,
		LONG *	hour,
		LONG *	min,
		LONG *	voice,
		LONG *	way,
		LONG *	InerBellDelay,
		LONG *	ExtBellDelay
	)

To query bell settings based on the specified weekday and bell index.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID weekDay LONG [in] Weekday Index LONG [in] Bell index Enable LONG* [out] Whether to enable the bell hour LONG* [out] Hour min LONG* [out] Minute voice LONG* [out] Ringtone way LONG* [out] Ringing mode InerBellDelay LONG* [out] Internal ringing duration ExtBellDelay LONG* [out] External ringing duration

Returns

Value description:

name	type	description of value
True	BOOL	Function execution success
False	BOOL	Function execution failure

See also

NMS_GetBellSchData

Attention

1. weekDay: specifies the weekday. The value 0 indicates Monday, 1 Tuesday, 2 Wednesday, 3 Thursday, 4 Friday, 5 Saturday, and 6 Sunday.

1. Index: specifies the bell index. The value range is 1-65535.
   
2. Enable: specifies whether to enable the bell. The value 0 indicates disabling the bell and 1 indicates enabling the bell.
   
3. voice: specifies the ringtone. The value ranges from 1 to 10, representing bell01.wav to bell10.wav respectively.
   
4. way: specifies the ringing mode. The value 0 indicates internal ringing, 1 external ringing, and 2 internal and external ringing.
   
5. InerBellDelay: specifies the internal ringing duration. The value ranges from 1 to 999, in seconds.
   
6. ExtBellDelay: specifies the external ringing duration. The value ranges from 1 to 999, in seconds.
   

Note

This interface is applicable to the new architecture firmware.

SetBellSchDataEx()

VARIANT_BOOL SetBellSchDataEx	(	LONG	dwMachineNumber,
		LONG	weekDay,
		LONG	Index,
		LONG	Enable,
		LONG	hour,
		LONG	min,
		LONG	voice,
		LONG	way,
		LONG	InerBellDelay,
		LONG	ExtBellDelay
	)

To set bell information.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID weekDay LONG [in] Weekday Index LONG [in] Bell index Enable LONG [in] Whether to enable the bell hour LONG [in] Hour min LONG [in] Minute voice LONG [in] Ringtone way LONG [in] Ringing mode InerBellDelay LONG [in] Internal ringing duration ExtBellDelay LONG [in] External ringing duration

Returns

Value description:

name	type	description of value
True	BOOL	Function execution success
False	BOOL	Function execution failure

See also

Attention

1. weekDay: specifies the weekday. At most 7 days in a whole week can be set. Specify the weekday by using the least significant 7 bits of a byte. You can set multiple weekdays.
The first bit indicates Monday (0x00000001), the second bit Tuesday (0x00000002), third bit Wednesday (0x00000004), fourth bit Thursday (0x00000008), fifth bit Friday (0x00000010), sixth bit Saturday (0x00000020), and seventh bit Sunday (0x00000040).
To set multiple days, add the corresponding values. For example, to set Monday and Thursday, add 1 and 8, making 9. To set Tuesday, Friday and Saturday, add 2, 16 and 32, making 50.

1. Index: specifies the bell index. The value range is 1-65535.
   
2. Enable: specifies whether to enable the bell. The value 0 indicates disabling the bell and 1 indicates enabling the bell.
   
3. voice: specifies the ringtone. The value ranges from 1 to 10, representing bell01.wav to bell10.wav respectively.
   
4. way: specifies the ringing mode. The value 0 indicates internal ringing, 1 external ringing, and 2 internal and external ringing.
   
5. InerBellDelay: specifies the internal ringing duration. The value ranges from 1 to 999, in seconds.
   
   1. ExtBellDelay: specifies the external ringing duration. The value ranges from 1 to 999, in seconds.
      

Note

This interface is applicable to the new architecture firmware.

GetDayBellSchCount()

VARIANT_BOOL GetDayBellSchCount	(	LONG	dwMachineNumber,
		LONG *	DayBellCnt
	)

To query the number of bells that are set on the machine.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID DayBellCnt LONG* [out] Bell quantity

Returns

Value description:

name	type	description of value
True	BOOL	Function execution success
False	BOOL	Function execution failure

See also

Attention

Note

This interface is applicable to the new architecture firmware.

GetMaxBellIDInBellSchData()

VARIANT_BOOL GetMaxBellIDInBellSchData	(	LONG	dwMachineNumber,
		LONG *	MaxBellID
	)

To obtain the maximum bell index among all bells.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID MaxBellID LONG* [out] Weekday

Returns

Value description:

name	type	description of value
True	BOOL	Function execution success
False	BOOL	Function execution failure

See also

NMS_GetMaxBellIDInBellSchData

Attention

Note

This interface is applicable to the new architecture firmware.

ReadAllBellSchData()

VARIANT_BOOL ReadAllBellSchData

(

LONG

dwMachineNumber

)

To read the information about all bells to the SDK memory.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID

Returns

Value description:

name	type	description of value
True	BOOL	Function execution success
False	BOOL	Function execution failure

See also

Attention

This function needs to be used together with GetEachBellInfo to obtain bell information.

Note

This interface is applicable to the new architecture firmware.

GetEachBellInfo()

VARIANT_BOOL GetEachBellInfo	(	LONG	dwMachineNumber,
		LONG *	weekDay,
		LONG *	Index,
		LONG *	Enable,
		LONG *	hour,
		LONG *	min,
		LONG *	voice,
		LONG *	way,
		LONG *	InerBellDelay,
		LONG *	ExtBellDelay
	)

To read bell information records from the SDK memory one by one.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID weekDay LONG* [out] Weekday Index LONG* [out] Bell index Enable LONG* [out] Whether to enable the bell hour LONG* [out] Hour min LONG* [out] Minute voice LONG* [out] Ringtone way LONG* [out] Ringing mode InerBellDelay LONG* [out] Internal ringing duration ExtBellDelay LONG* [out] External ringing duration

Returns

Value description:

name	type	description of value
True	BOOL	Function execution success
False	BOOL	Function execution failure

See also

Attention

1. This function needs to be used together with ReadAllBellSchData, which is used to read all bell information to the memory.

1. weekDay: specifies the weekday. At most 7 days in a whole week can be set. Specify the weekday by using the least significant 7 bits of a byte. You can set multiple weekdays.
   The first bit indicates Monday (0x00000001), the second bit Tuesday (0x00000002), third bit Wednesday (0x00000004), fourth bit Thursday (0x00000008), fifth bit Friday (0x00000010), sixth bit Saturday (0x00000020), and seventh bit Sunday (0x00000040).
   You can learn the weekday settings by checking whether the corresponding bit is set. For example, if the returned value is 50, which is the sum of 0x00000002, 0x00000010 and 0x00000020, the bell is set to ring on Tuesday, Friday and Saturday.
   
2. Index: specifies the bell index. The value range is 1-65535.
   
3. Enable: specifies whether to enable the bell. The value 0 indicates disabling the bell and 1 indicates enabling the bell.
   
4. voice: specifies the ringtone. The value ranges from 1 to 10, representing bell01.wav to bell10.wav respectively.
   
5. way: specifies the ringing mode. The value 0 indicates internal ringing, 1 external ringing, and 2 internal and external ringing.
   
6. InerBellDelay: specifies the internal ringing duration. The value ranges from 1 to 999, in seconds.
   
7. ExtBellDelay: specifies the external ringing duration. The value ranges from 1 to 999, in seconds.
   

Note

This interface is applicable to the new architecture firmware.