IDeviceConfiguration
Create an instance of the IDeviceConfiguration using getDeviceConfiguration(). Then use the function calls described in this chapter.
Generally, these functions will run in one of two modes:
Asynchronous functions return data in the event handlers in section.
Synchronous functions return data in the return value. If the data is not available immediately, the call will block until a wait time has elapsed.
deleteFile
This function deletes a file from the device.
Copy
int IDeviceConfiguration.deleteFile(byte[] fileID);Parameter
fileID Byte array for the file ID. For DynaFlex, use a 4-byte file id. 0x02000000 = Custom idle page image 1
0x02000001 = Custom idle page image 2 0x02000002 = Custom idle page image 3 0x02000003 = Custom idle page image 4
Return Value:
Returns 0 if the asynchronous update operation started. Otherwise, returns a non 0 value.
getChallengeToken
This function retrieves a challenge token from the device. A challenge token consists of a random nonce or timestamp. A challenge token must be used within the time allowed by the device (generally 5 minutes) of being issued. Only one token can be active at a time. Attempts to use a token for requests other than the one specified will cause the token to be revoked/erased.
Copy
Parameter
data Byte array containing the request ID to be protected.
Return Value:
Returns a byte array containing the challenge token.
getConfigInfo
This function retrieves device configuration information.
Copy
Parameter
configType Type of configuration. For DynaFlex, this is the function ID.
data Configuration data to be sent to the device. For DynaFlex, this is the OID.
Return Value:
Returns an array of bytes containing the configuration information.
getDeviceInfo
This function retrieves device specific information.
Copy
Parameter
infoType Enumerated information type.
Return Value:
Returns a string value device information.
getFile
This function retrieves device specific information.
Copy
Parameter
fileID Byte array for the file ID. For DynaFlex, use a 4-byte file id.
callback Name of a class or structure that implements the IConfigurationCallback Delegates events.
Return Value:
Returns a string value device information.
getKeyInfo
This function retrieves key information.
Copy
Parameter
keyType Type of key. For DynaFlex, use 0.
data Key data to be sent to the device. For DynaFlex, this is the 2-byte key slot number.
Return Value:
Returns an array of bytes containing the key information.
sendFile
This function sends a file to the device.
Copy
Parameter
fileID Byte array for the file ID. For DynaFlex, use a 4-byte file id.
data File contents to be sent to the device.
callback Name of a class or structure that implements the IConfigurationCallback Delegates events.
Return Value:
Returns 0 if the asynchronous update operation started. Otherwise, returns a non 0 value.
sendImage
This function sends an image to the device.
Copy
Parameter
imageID Value for the image ID. For DynaFlex, use:
1, 2, 3, or 4
data File contents to be sent to the device.
Images must be BMP format, 160KB or smaller with no compression, maximum 320px by 240px, with color depth 16 color, 256 color, 16-bit color, 24-bit color. Images smaller than the maximum size are centered on the display. Note images at full screen size must be 16-bit color or lower to meet the size requirement.
For details see D998200383 DynaFlex Family Programmer's Manual (Commands).
callback Name of a class or structure that implements the IConfigurationCallback Delegates events.
Return Value:
Returns 0 if the asynchronous update operation started. Otherwise, returns a non 0 value.
sendSecureFile
This function sends a file to the device using a secure command structure.
Copy
Parameter
fileID Byte array for the file ID. For DynaFlex, use a 4-byte file id.
data File contents to be sent to the device.
callback Name of a class or structure that implements the IConfigurationCallback Delegates events.
Return Value:
Returns 0 if the asynchronous update operation started. Otherwise, returns a non 0 value.
setConfigInfo
This function sets device configuration information.
Copy
Parameter
configType Type of configuration. For DynaFlex, this is the function ID.
data Configuration data to be sent to the device.
callback Name of a class or structure that implements the IConfigurationCallback Delegates events.
Return Value:
Returns 0 if the asynchronous configuration operation started. Otherwise, returns a non 0 value.
setDisplayImage
This function sets which image is to be displayed when the device is idle.
Copy
Parameter
imageID Value for the image ID. For DynaFlex, use:
0, 1, 2, 3, or 4
Where 0 substitutes the “Welcome” screen.
Return Value:
Returns 0 if the asynchronous configuration operation started. Otherwise, returns a non 0 value.
updateFirmware
This function updates the device firmware.
Copy
Parameter
firmwareType Type of firmware. For DynaFlex, use:
1 - Main App
data Firmware image to be sent to the device.
callback Name of a class or structure that implements the IConfigurationCallback Delegates events.
Return Value:
Returns 0 if the asynchronous update operation started. Otherwise, returns a non 0 value.
updateKeyInfo
This function updates key information in the device.
Copy
Parameter
keyType Type of key.
data Key data to be sent to the device.
callback Name of a class or structure that implements the IConfigurationCallback Delegates events.
Return Value:
Returns 0 if the asynchronous update operation started. Otherwise, returns a non 0 value.