Configuration option | Description |
requestAllDevices | Request all assets at startup. Type: boolean. Default: true. |
subscribeToAllMeasurements | Subscribe to measurements of all devices during startup. Type: boolean. Default: true. |
subscribeToDevices | Subscribe to all device-related updates. Type: boolean. Default: true. |
subscribeToOperations | Subscribe to all device operations. Type: boolean. Default: false. |
tenant | Unique name of the application tenant. Type: string. |
username | User name for authentication. Type: string. |
password | Password for authentication. Type: string. |
appKey | Unique key for the application defined on the Cumulocity IoT instance. Type: string. The application key is defined in Cumulocity IoT. Log in to your account in Cumulocity IoT, and use the Administration application to add an external application. You can then specify the application key and the URL of the application. See the Cumulocity IoT documentation at http://cumulocity.com/guides/ for more information. |
url | Optional. URL if connecting to an on-premise installation of Cumulocity IoT. Type: string. |
forceInitialHost | By default, the endpoint details returned by the Cumulocity IoT platform are used. Set this to true if you want to configure the Cumulocity SDK to always use the URL provided during session initialization instead of the endpoint details. This is helpful in deployment scenarios where the Cumulocity IoT instance is reachable only with an IP address. Type: boolean. Default: false. |
pageSize | Optional. The page size to be used for retrieving resources from Cumulocity IoT. Type: integer. Default: The default value is inherited from the Cumulocity SDK (currently set to 5). |
useBatching | While creating resources with Cumulocity IoT, multiple requests of the same kind can be grouped together and sent as a single batch. This improves publishing performance by avoiding sending multiple requests to Cumulocity IoT. Bulk creation is currently supported only for creating measurement events. Type: boolean. Default: false. |