3 query – Kramer Electronics SP-14 User Manual

Page 16

Advertising
background image

3.2.3 Query
The query function provides information about the functions implemented for each parameter. There

are two type of query function: single query and a query all functions.

The single query will return true (1) or false (0) indicating if the function for the specified function,

attribute, parameter combination is implemented.

The query all will return a value where the binary digits indicate where specific functions/attribute

combination as been implemented. Set the function value to avParFunc_queryAll in the following

packet.

3.2.3.1 Query Request Packet

1

2

3

4

5

6

7

8

9

10 11 12 13 14 15 16

‘A’

‘P’ ‘A’

paramID

attribute

value

‘A’

Where

‘A’, ‘P’

are literal ASCII characters.

paramID

is the parameter identifier being queried.

attribute

is the attribute identifier being queried.

value

is the function being queried (see the following table).

Function to be queried:
Identifier

Value

Base 64

Description

avParFunc_get

0

AAAAAA Query the get value function.

avParFunc_set

1

AAAAAB Query the set value function.

avParFunc_gets

2

AAAAAC Query the get string function.

avParFunc_sets

3

AAAAAD Query the set string function.

avParFunc_queryAll

4

AAAAAE Query all the parameter functions.

For query all set attribute to avParamAttr_avail.

3.2.3.2 Query Reply
On successful completion the query function will return a value see

3.2.2.2 Success Reply Packet

with return value”.

For a single query function call the possible values returned will be:

0 (AAAAAA in base 64) for false

1 (AAAAAB in base 64) for true

For a query all function call the value return will be a binary bit pattern. Specific binary digits represent

true or false indicating if specific functions are implemented.

These are the bit masks to identify each function flag:
Identifier

Bit

Base 16

Description

avQueryFunc_get_avail

0

0x0001

Availability function for parameter.

avQueryFunc_get_availValue

1

0x0002

Availability function for specific value.

avQueryFunc_get_min

2

0x0004

Function that returns the minimum

value.

avQueryFunc_get_max

3

0x0008

Function that returns the maximum

value.

avQueryFunc_get_val

4

0x0010

Get value function.

avQueryFunc_get_e2val

5

0x0020

Get value function (NV).

avQueryFunc_set_val

6

0x0040

Set value function (live).

avQueryFunc_set_e2val

7

0x0080

Set value function (NV/Save).

avQueryFunc_gets

8

0x0100

Get string function.

avQueryFunc_sets

9

0x0200

Set string function.

Advertising