IPWorks IoT 2020 Node.js Edition

Questions / Feedback?

ResponseOptionValueType Property

The option's value data type.

Syntax

 coap.getResponseOptionValueType(index, [callback])
 coap.setResponseOptionValueType(index,  responseOptionValueType, [callback])

Possible Values

  0 (ovtString), 
  1 (ovtUInt), 
  2 (ovtBinary)

Default Value

0

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getResponseOptionValueType([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setResponseOptionValueType([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

The option's value data type.

This property specifies the data type of the option's ResponseOptionValue. If ResponseOptionNumber is set to a recognized value (refer to the table in its documentation), this property will automatically be set to the correct value. The table below shows the possible value types, their descriptions, and how to format the data assigned to ResponseOptionValue.

Type Description Value Format
ovtString (0) (default) String String
ovtUInt (1) Unsigned integer 0 to 4294967295
ovtBinary (2) Binary data Hex-encoded byte string

The index parameter specifies the index of the item in the array. The size of the array is controlled by the ResponseOptionCount property.

This property is not available at design time.

Data Type

Integer

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks IoT 2020 Node.js Edition - Version 20.0 [Build 8265]