Welcome to Kepware Server > Configuration API Service > Configuration API Service — Device Properties
Configuration API Service — Device Properties
Configuration API Service — Device Properties
The following properties define a device using the Configuration API service.
 
General Properties
 
common.ALLTYPES_NAME * Required parameter
 
common.ALLTYPES_DESCRIPTION
 
servermain.DEVICE_CHANNEL_ASSIGNMENT
 
servermain.MULTIPLE_TYPES_DEVICE_DRIVER * Required parameter
 
servermain.DEVICE_MODEL * Not required, but verify the default is acceptable
 
servermain.DEVICE_ID_STRING * Required parameter
 
servermain.DEVICE_DATA_COLLECTION
 
servermain.DEVICE_SIMULATED
 
Scan Mode
 
servermain.DEVICE_SCAN_MODE
 
servermain.DEVICE_SCAN_MODE_RATE_MS
 
servermain.DEVICE_SCAN_MODE_RATE_MS
 
servermain.DEVICE_SCAN_MODE_PROVIDE_INITIAL_UPDATES_FROM_CACHE
 
Auto Demotion
 
servermain.DEVICE_AUTO_DEMOTION_ENABLE_ON_COMMUNICATIONS_FAILURES
 
servermain.DEVICE_AUTO_DEMOTION_DEMOTE_AFTER_SUCCESSIVE_TIMEOUTS
 
servermain.DEVICE_AUTO_DEMOTION_PERIOD_MS
 
servermain.DEVICE_AUTO_DEMOTION_DISCARD_WRITES
 
Tag Generation
 
servermain.DEVICE_TAG_GENERATION_ON_STARTUP
 
servermain.DEVICE_TAG_GENERATION_DUPLICATE_HANDLING
 
servermain.DEVICE_TAG_GENERATION_GROUP
 
servermain.DEVICE_TAG_GENERATION_ALLOW_SUB_GROUPS
 
Tip: To Invoke Automatic Tag Generation, send a PUT with an empty body to the TagGeneration service endpoint on the device.
Note: All files in the user_data directory must be world readable or owned by the Kepware user and group that were created during installation, by default kepedge.
See Also: For more information, see Services help.
 
Timing
servermain.DEVICE_CONNECTION_TIMEOUT_SECONDS
 
servermain.DEVICE_REQUEST_TIMEOUT_MILLISECONDS
 
servermain.DEVICE_RETRY_ATTEMPTS
 
servermain.DEVICE_INTER_REQUEST_DELAY_MILLISECONDS
 
See Also : The server help system Configuration API Service section.
 
Was this helpful?