Skip to content

Latest commit

 

History

History
 
 

use_case_1

Use Case 1: Request Asset Details

With this use case, you can request different kinds of asset data (examples below).

Plant Data

This code demonstrates how to get the information of every plant in the organization

Execute

To run this demo, execute the following script:

python use_case_1/get_plant_data.py

Result

Click for Sample Output

Organization 1234, Tasty Manufacturing

{'address': 'Smart Street 1, 10001 New York, USA',
 'city': 'New York',
 'country': 'USA',
 'industryTypeID': 3,
 'industryTypeName': 'Other',
 'locationLatitude': '-74.00594130000000000000',
 'locationLongitude': '40.71278370000000000000',
 'organization': {'isPrivateOrgarnization': False,
                  'organizationID': 1234,
                  'organizationName': 'Tasty Manufacturing'},
 'pinNumber': '12345',
 'plantID': 5678,
 'plantName': 'Food Factory',
 'siteIdentifier': None,
 'uniqueID': '1234abcd-1a2b-3c4d-5d6f-abcd1234ffff'}

Simplified Asset Data

This code shows the information of all the assets belonging to the user's current organization.

Execute

To run this demo, execute the following script:

python use_case_1/get_simplified_asset_data.py

Result

Click for Sample Output

Organization 1234, Tasty Manufacturing

Plant 5678, Food Factory:
Assets:
{'assetGroupID': 1000,
 'assetID': 2000,
 'assetName': 'Motor 1',
 'assetResponsibleID': None,
 'assetResponsibleName': None,
 'assetType': {'assetTypeID': 1, 'assetTypeName': 'Motor'},
 'configurationProfileID': 3,
 'configurationProfileName': 'Motor Profile',
 'createdOn': '2018-01-12T16:23:45.931',
 'description': None,
 'healthStatus': {'healthCode': 'Healthy', 'healthColor': '#21BE89'},
 'isFavourite': False,
 'isPowerTrainComponent': False,
 'lastSyncTimeStamp': '2018-01-13T16:23:45.931',
 'lastUpdatedOn': '2018-01-14T16:23:45.931',
 'locationLatitude': '',
 'locationLongitude': '',
 'organization': {'isPrivateOrgarnization': False,
                  'organizationID': 1234,
                  'organizationName': 'Tasty Manufacturing'},
 'plantID': 5678,
 'plantName': 'Food Factory',
 'sensorIdentifier': 'S2A0000001-ABCD',
 'sensorTypeID': 1,
 'serialNumber': '10',
 'siteIdentifier': None}

Detailed Sensor and Asset Data

This code shows the detailed information of all the assets belonging to the user's current organization.

Execute

To run this demo, execute the following script:

python use_case_1/get_detailed_sensor_and_asset_data.py

Result

Click for Sample Output

Organization 1234, Tasty Manufacturing

Plant 5678, Food Factory:
Assets:
Detailed data of Asset 2000, Motor 1:
{'assetGroupID': 1000,
 'assetGroupName': 'Group 1',
 'assetID': 2000,
 'assetName': 'Motor 1',
 'assetPictures': [],
 'assetProperties': [{'assetPropertyAvailableValueID': 1,
                      'assetPropertyDataType': 'Identifier',
                      'assetPropertyName': 'Motor Standard',
                      'assetPropertyPrecision': 0,
                      'assetPropertySequenceNr': 101,
                      'assetPropertyType': 'MotorClass',
                      'assetPropertyValue': 'IEC',
                      'isEnabled': True,
                      'measurementUnitGroup': None},
                     {'assetPropertyAvailableValueID': 13,
                      'assetPropertyDataType': 'Identifier',
                      'assetPropertyName': 'Speed Control',
                      'assetPropertyPrecision': 0,
                      'assetPropertySequenceNr': 102,
                      'assetPropertyType': 'MotorType',
                      'assetPropertyValue': 'Fixed Speed',
                      'isEnabled': True,
                      'measurementUnitGroup': None},
                     {'assetPropertyAvailableValueID': None,
                      'assetPropertyDataType': 'Decimal',
                      'assetPropertyName': 'Voltage',
                      'assetPropertyPrecision': 0,
                      'assetPropertySequenceNr': 103,
                      'assetPropertyType': 'Nameplate_Voltage',
                      'assetPropertyValue': '123.0000',
                      'isEnabled': True,
                      'measurementUnitGroup': {'measurementUnitGroupID': 8,
                                               'measurementUnitGroupName': 'Voltage '
                                                                           'Unit'}},
                     {'assetPropertyAvailableValueID': None,
                      'assetPropertyDataType': 'Decimal',
                      'assetPropertyName': 'Current',
                      'assetPropertyPrecision': 2,
                      'assetPropertySequenceNr': 104,
                      'assetPropertyType': 'Nameplate_Current',
                      'assetPropertyValue': '3.0000',
                      'isEnabled': True,
                      'measurementUnitGroup': {'measurementUnitGroupID': 9,
                                               'measurementUnitGroupName': 'Ampere '
                                                                           'Unit'}},
                     {'assetPropertyAvailableValueID': None,
                      'assetPropertyDataType': 'Decimal',
                      'assetPropertyName': 'Speed',
                      'assetPropertyPrecision': 1,
                      'assetPropertySequenceNr': 101,
                      'assetPropertyType': 'Nameplate_Speed',
                      'assetPropertyValue': '1250.0000',
                      'isEnabled': True,
                      'measurementUnitGroup': {'measurementUnitGroupID': 14,
                                               'measurementUnitGroupName': 'Rotation '
                                                                           'Unit'}},
                     {'assetPropertyAvailableValueID': None,
                      'assetPropertyDataType': 'String',
                      'assetPropertyName': 'DE Bearing',
                      'assetPropertyPrecision': 0,
                      'assetPropertySequenceNr': 109,
                      'assetPropertyType': 'Nameplate_DSBearing',
                      'assetPropertyValue': '1234',
                      'isEnabled': True,
                      'measurementUnitGroup': None},
                     {'assetPropertyAvailableValueID': None,
                      'assetPropertyDataType': 'String',
                      'assetPropertyName': 'NDE Bearing',
                      'assetPropertyPrecision': 0,
                      'assetPropertySequenceNr': 111,
                      'assetPropertyType': 'Nameplate_NDSBearing',
                      'assetPropertyValue': '1234',
                      'isEnabled': True,
                      'measurementUnitGroup': None},
                     {'assetPropertyAvailableValueID': None,
                      'assetPropertyDataType': 'Decimal',
                      'assetPropertyName': 'Power Factor',
                      'assetPropertyPrecision': 2,
                      'assetPropertySequenceNr': 108,
                      'assetPropertyType': 'Nameplate_PowerFact',
                      'assetPropertyValue': '0.5000',
                      'isEnabled': True,
                      'measurementUnitGroup': None},
                     {'assetPropertyAvailableValueID': None,
                      'assetPropertyDataType': 'Decimal',
                      'assetPropertyName': 'Power',
                      'assetPropertyPrecision': 2,
                      'assetPropertySequenceNr': 105,
                      'assetPropertyType': 'Nameplate_Power',
                      'assetPropertyValue': '60.0000',
                      'isEnabled': True,
                      'measurementUnitGroup': {'measurementUnitGroupID': 5,
                                               'measurementUnitGroupName': 'Power '
                                                                           'Unit'}},
                     {'assetPropertyAvailableValueID': None,
                      'assetPropertyDataType': 'Decimal',
                      'assetPropertyName': 'Line Frequency',
                      'assetPropertyPrecision': 1,
                      'assetPropertySequenceNr': 106,
                      'assetPropertyType': 'Nameplate_LineFrequency',
                      'assetPropertyValue': '60.0000',
                      'isEnabled': True,
                      'measurementUnitGroup': {'measurementUnitGroupID': 10,
                                               'measurementUnitGroupName': 'Frequency '
                                                                           'Unit'}},
                     {'assetPropertyAvailableValueID': None,
                      'assetPropertyDataType': 'String',
                      'assetPropertyName': 'DE Manufacturer',
                      'assetPropertyPrecision': 0,
                      'assetPropertySequenceNr': 110,
                      'assetPropertyType': 'Nameplate_DS_Manufacturer',
                      'assetPropertyValue': 'ABCD',
                      'isEnabled': True,
                      'measurementUnitGroup': None},
                     {'assetPropertyAvailableValueID': None,
                      'assetPropertyDataType': 'String',
                      'assetPropertyName': 'NDE Manufacturer',
                      'assetPropertyPrecision': 0,
                      'assetPropertySequenceNr': 112,
                      'assetPropertyType': 'Nameplate_NDS_Manufacturer',
                      'assetPropertyValue': 'ABCD',
                      'isEnabled': True,
                      'measurementUnitGroup': None},
                     {'assetPropertyAvailableValueID': None,
                      'assetPropertyDataType': 'Boolean',
                      'assetPropertyName': 'DE Bearing Sealed',
                      'assetPropertyPrecision': 0,
                      'assetPropertySequenceNr': 120,
                      'assetPropertyType': 'Greasing_IsBearingSealed',
                      'assetPropertyValue': '0',
                      'isEnabled': False,
                      'measurementUnitGroup': None},
                     {'assetPropertyAvailableValueID': None,
                      'assetPropertyDataType': 'Decimal',
                      'assetPropertyName': 'DE Dimension Factor',
                      'assetPropertyPrecision': 0,
                      'assetPropertySequenceNr': 119,
                      'assetPropertyType': 'Greasing_DimensionFactor',
                      'assetPropertyValue': '21.3000',
                      'isEnabled': False,
                      'measurementUnitGroup': None},
                     {'assetPropertyAvailableValueID': 25,
                      'assetPropertyDataType': 'Identifier',
                      'assetPropertyName': 'Motor Type',
                      'assetPropertyPrecision': 0,
                      'assetPropertySequenceNr': 131,
                      'assetPropertyType': 'ShaftRotationType',
                      'assetPropertyValue': 'Induction',
                      'isEnabled': True,
                      'measurementUnitGroup': None}],
 'assetResponsibleID': None,
 'assetResponsibleName': None,
 'assetType': {'assetTypeID': 1, 'assetTypeName': 'Motor'},
 'condition': [{'conditionIndexKey': 'ConditionIndexForAvailability',
                'conditionIndexName': 'Availability',
                'conditionIndexStatus': {'status': 'NotApplicable',
                                         'statusCode': None,
                                         'statusCodeMessage': None}},
               {'conditionIndexKey': 'ConditionIndexForEnvironment',
                'conditionIndexName': 'Environment',
                'conditionIndexStatus': {'status': 'Good',
                                         'statusCode': None,
                                         'statusCodeMessage': None}},
               {'conditionIndexKey': 'ConditionIndexForReliability',
                'conditionIndexName': 'Reliability',
                'conditionIndexStatus': {'status': 'Good',
                                         'statusCode': None,
                                         'statusCodeMessage': None}},
               {'conditionIndexKey': 'ConditionIndexForStress',
                'conditionIndexName': 'Stress',
                'conditionIndexStatus': {'status': 'Unknown',
                                         'statusCode': 'NoKPIVals',
                                         'statusCodeMessage': 'There are no '
                                                              'measurements '
                                                              'loaded in the '
                                                              'last 7 days'}},
               {'conditionIndexKey': 'OverallConditionIndex',
                'conditionIndexName': 'Overall Condition Index',
                'conditionIndexStatus': {'status': 'Good',
                                         'statusCode': None,
                                         'statusCodeMessage': None}}],
 'configurationProfileID': 3,
 'configurationProfileName': 'Motor Profile',
 'createdOn': '2018-01-12T16:23:45.931',
 'description': None,
 'firmwareUpdate': {'updateAvailable': True,
                    'updateFirmwareID': 60,
                    'updateFirmwareVersion': '9.1'},
 'healthStatus': {'healthCode': 'Healthy', 'healthColor': '#21BE89'},
 'isFavourite': False,
 'isGroup': True,
 'isPowerTrainComponent': False,
 'labels': [],
 'lastSyncTimeStamp': '2018-01-13T16:23:45',
 'lastUpdatedOn': '2018-01-14T16:23:45',
 'locationLatitude': '',
 'locationLongitude': '',
 'measurements': [{'enableDataValidation': False,
                   'healthStatus': {'healthCode': 'Undefined',
                                    'healthColor': None},
                   'isCalibrationEnabled': False,
                   'isCumulative': False,
                   'isEditable': False,
                   'isHealthParameter': False,
                   'isVisible': True,
                   'measurementCalibration': None,
                   'measurementTypeCode': 'Speed',
                   'measurementTypeDescription': 'Rotational speed of the '
                                                 'shaft, measured in '
                                                 'revolutions per minute (rpm)',
                   'measurementTypeID': 2,
                   'measurementTypeName': 'Speed',
                   'measurementTypePrecision': 0,
                   'measurementTypeSequenceNo': 250,
                   'measurementTypeUnitGroupID': 14,
                   'measurementTypeUnitGroupName': None,
                   'measurementValue': '0.0000',
                   'qualityFlag': 'NotValidated',
                   'timeStamp': '2018-01-14T16:23:45',
                   'uniqueID': '1234abcd-1a2b-3c4d-5d6f-abcd1234ffff'},
                  {'enableDataValidation': True,
                   'healthStatus': {'healthCode': 'Healthy',
                                    'healthColor': '#21BE89'},
                   'isCalibrationEnabled': True,
                   'isCumulative': False,
                   'isEditable': True,
                   'isHealthParameter': True,
                   'isVisible': True,
                   'measurementCalibration': None,
                   'measurementTypeCode': 'SkinTemp',
                   'measurementTypeDescription': 'Temperature in °C or °F, '
                                                 'measured in the contact '
                                                 'point where the sensor tag '
                                                 'touches the mounting parts.',
                   'measurementTypeID': 4,
                   'measurementTypeName': 'Skin Temperature',
                   'measurementTypePrecision': 0,
                   'measurementTypeSequenceNo': 251,
                   'measurementTypeUnitGroupID': 4,
                   'measurementTypeUnitGroupName': None,
                   'measurementValue': '38.1232',
                   'qualityFlag': 'Success',
                   'timeStamp': '2018-01-14T16:23:45',
                   'uniqueID': '1234abcd-1a2b-3c4d-5d6f-abcd1234ffff'},
                  {'enableDataValidation': False,
                   'healthStatus': {'healthCode': 'Healthy',
                                    'healthColor': '#21BE89'},
                   'isCalibrationEnabled': False,
                   'isCumulative': False,
                   'isEditable': True,
                   'isHealthParameter': True,
                   'isVisible': True,
                   'measurementCalibration': None,
                   'measurementTypeCode': 'OverallVibration',
                   'measurementTypeDescription': 'Vibration velocity, '
                                                 'rms-value in mm/s or in/s, '
                                                 'always showing whichever is '
                                                 'the highest value of the '
                                                 'three directions: Radial, '
                                                 'Tangential, Axial.',
                   'measurementTypeID': 8,
                   'measurementTypeName': 'Overall Vibration',
                   'measurementTypePrecision': 3,
                   'measurementTypeSequenceNo': 201,
                   'measurementTypeUnitGroupID': 6,
                   'measurementTypeUnitGroupName': None,
                   'measurementValue': '0.0451',
                   'qualityFlag': 'NotValidated',
                   'timeStamp': '2018-01-14T16:23:45',
                   'uniqueID': '1234abcd-1a2b-3c4d-5d6f-abcd1234ffff'},
                  {'enableDataValidation': False,
                   'healthStatus': {'healthCode': 'Undefined',
                                    'healthColor': None},
                   'isCalibrationEnabled': False,
                   'isCumulative': True,
                   'isEditable': False,
                   'isHealthParameter': False,
                   'isVisible': True,
                   'measurementCalibration': None,
                   'measurementTypeCode': 'Operating',
                   'measurementTypeDescription': 'The number of hours since '
                                                 'the commissioning of the '
                                                 'sensor during which the '
                                                 'motor has been in operation '
                                                 'and not standing still.',
                   'measurementTypeID': 9,
                   'measurementTypeName': 'Operating Time',
                   'measurementTypePrecision': 0,
                   'measurementTypeSequenceNo': 252,
                   'measurementTypeUnitGroupID': 13,
                   'measurementTypeUnitGroupName': None,
                   'measurementValue': '80.0000',
                   'qualityFlag': 'NotValidated',
                   'timeStamp': '2018-01-14T16:23:45',
                   'uniqueID': '1234abcd-1a2b-3c4d-5d6f-abcd1234ffff'},
                  {'enableDataValidation': False,
                   'healthStatus': {'healthCode': 'Undefined',
                                    'healthColor': None},
                   'isCalibrationEnabled': False,
                   'isCumulative': True,
                   'isEditable': False,
                   'isHealthParameter': False,
                   'isVisible': True,
                   'measurementCalibration': None,
                   'measurementTypeCode': 'NumberOfStarts',
                   'measurementTypeDescription': 'The number of times in the '
                                                 'measurement period, that '
                                                 'motor has gone from '
                                                 'standstill to operation.',
                   'measurementTypeID': 10,
                   'measurementTypeName': 'Number of Starts',
                   'measurementTypePrecision': 0,
                   'measurementTypeSequenceNo': 253,
                   'measurementTypeUnitGroupID': 0,
                   'measurementTypeUnitGroupName': None,
                   'measurementValue': '3.0000',
                   'qualityFlag': 'NotValidated',
                   'timeStamp': '2018-01-14T16:23:45',
                   'uniqueID': '1234abcd-1a2b-3c4d-5d6f-abcd1234ffff'},
                  {'enableDataValidation': False,
                   'healthStatus': {'healthCode': 'Undefined',
                                    'healthColor': None},
                   'isCalibrationEnabled': False,
                   'isCumulative': False,
                   'isEditable': False,
                   'isHealthParameter': False,
                   'isVisible': True,
                   'measurementCalibration': None,
                   'measurementTypeCode': 'LineFrequency',
                   'measurementTypeDescription': 'Frequency of the AC-voltage '
                                                 'from the electric supply '
                                                 'network, measured in Hz.',
                   'measurementTypeID': 15,
                   'measurementTypeName': 'Motor Supply Frequency',
                   'measurementTypePrecision': 0,
                   'measurementTypeSequenceNo': 257,
                   'measurementTypeUnitGroupID': 10,
                   'measurementTypeUnitGroupName': None,
                   'measurementValue': '2.0000',
                   'qualityFlag': 'NotValidated',
                   'timeStamp': '2018-01-14T16:23:45',
                   'uniqueID': '1234abcd-1a2b-3c4d-5d6f-abcd1234ffff'},
                  {'enableDataValidation': False,
                   'healthStatus': {'healthCode': 'Healthy',
                                    'healthColor': '#21BE89'},
                   'isCalibrationEnabled': False,
                   'isCumulative': False,
                   'isEditable': False,
                   'isHealthParameter': True,
                   'isVisible': True,
                   'measurementCalibration': None,
                   'measurementTypeCode': 'BearingCondition',
                   'measurementTypeDescription': 'The bearing condition is '
                                                 'calculated for each '
                                                 'measurement. A condition '
                                                 'below 5 means that the '
                                                 'measurement did not reveal '
                                                 'signs of damage. A condition '
                                                 'between 5 and 10 means that '
                                                 'signs of a developing damage '
                                                 'were detected. A condition '
                                                 'higher   than 10 means that '
                                                 'significant damage was '
                                                 'detected . The bearing '
                                                 'condition is based on such '
                                                 'factors as the vibration '
                                                 'spectrum. It has a highly '
                                                 'transient behaviour and can '
                                                 'change significantly from '
                                                 'one measurement to the next.',
                   'measurementTypeID': 27,
                   'measurementTypeName': 'Bearing Condition',
                   'measurementTypePrecision': 0,
                   'measurementTypeSequenceNo': 225,
                   'measurementTypeUnitGroupID': 0,
                   'measurementTypeUnitGroupName': None,
                   'measurementValue': '0.0000',
                   'qualityFlag': 'NotValidated',
                   'timeStamp': '2018-01-14T16:23:45',
                   'uniqueID': '1234abcd-1a2b-3c4d-5d6f-abcd1234ffff'},
                  {'enableDataValidation': False,
                   'healthStatus': {'healthCode': 'Undefined',
                                    'healthColor': None},
                   'isCalibrationEnabled': False,
                   'isCumulative': False,
                   'isEditable': False,
                   'isHealthParameter': False,
                   'isVisible': True,
                   'measurementCalibration': None,
                   'measurementTypeCode': 'Acc_z',
                   'measurementTypeDescription': 'Vibration velocity, '
                                                 'rms-value in mm/s or in/s, '
                                                 'measured in the direction '
                                                 'that is perpendicular to the '
                                                 'baseplate of the smart '
                                                 'sensor tag.',
                   'measurementTypeID': 31,
                   'measurementTypeName': 'Vibration (Radial)',
                   'measurementTypePrecision': 3,
                   'measurementTypeSequenceNo': 202,
                   'measurementTypeUnitGroupID': 6,
                   'measurementTypeUnitGroupName': None,
                   'measurementValue': '0.0987',
                   'qualityFlag': 'NotValidated',
                   'timeStamp': '2018-01-14T16:23:45',
                   'uniqueID': '1234abcd-1a2b-3c4d-5d6f-abcd1234ffff'},
                  {'enableDataValidation': False,
                   'healthStatus': {'healthCode': 'Undefined',
                                    'healthColor': None},
                   'isCalibrationEnabled': False,
                   'isCumulative': False,
                   'isEditable': False,
                   'isHealthParameter': False,
                   'isVisible': True,
                   'measurementCalibration': None,
                   'measurementTypeCode': 'Acc_y',
                   'measurementTypeDescription': 'Vibration velocity, '
                                                 'rms-value in mm/s or in/s, '
                                                 'measured in the direction of '
                                                 'the short edge of the smart '
                                                 'sensor tag.\r\n'
                                                 '\r\n'
                                                 'NOTE: Either the long edge '
                                                 '(preferred) or the short '
                                                 'edge of the sensor MUST '
                                                 'always be parallel to the '
                                                 'motor shaft.',
                   'measurementTypeID': 32,
                   'measurementTypeName': 'Vibration (Tangential)',
                   'measurementTypePrecision': 3,
                   'measurementTypeSequenceNo': 203,
                   'measurementTypeUnitGroupID': 6,
                   'measurementTypeUnitGroupName': None,
                   'measurementValue': '0.1234',
                   'qualityFlag': 'NotValidated',
                   'timeStamp': '2018-01-14T16:23:45',
                   'uniqueID': '1234abcd-1a2b-3c4d-5d6f-abcd1234ffff'},
                  {'enableDataValidation': False,
                   'healthStatus': {'healthCode': 'Undefined',
                                    'healthColor': None},
                   'isCalibrationEnabled': False,
                   'isCumulative': False,
                   'isEditable': False,
                   'isHealthParameter': False,
                   'isVisible': True,
                   'measurementCalibration': None,
                   'measurementTypeCode': 'Acc_x',
                   'measurementTypeDescription': 'Vibration velocity mm/s rms, '
                                                 'measured in the direction of '
                                                 'the long edge of the smart '
                                                 'sensor tag.\r\n'
                                                 '\r\n'
                                                 'NOTE: Either the long edge '
                                                 '(preferred) or the short '
                                                 'edge of the sensor MUST '
                                                 'always be parallel to the '
                                                 'motor shaft.',
                   'measurementTypeID': 33,
                   'measurementTypeName': 'Vibration (Axial)',
                   'measurementTypePrecision': 3,
                   'measurementTypeSequenceNo': 204,
                   'measurementTypeUnitGroupID': 6,
                   'measurementTypeUnitGroupName': None,
                   'measurementValue': '0.1234',
                   'qualityFlag': 'NotValidated',
                   'timeStamp': '2018-01-14T16:23:45',
                   'uniqueID': '1234abcd-1a2b-3c4d-5d6f-abcd1234ffff'},
                  {'enableDataValidation': False,
                   'healthStatus': {'healthCode': 'Undefined',
                                    'healthColor': None},
                   'isCalibrationEnabled': False,
                   'isCumulative': False,
                   'isEditable': False,
                   'isHealthParameter': False,
                   'isVisible': True,
                   'measurementCalibration': None,
                   'measurementTypeCode': 'EnergyConsumption',
                   'measurementTypeDescription': 'Output power, measured in '
                                                 'kWh, is the energy '
                                                 'consumption of the motor '
                                                 'calculated over the period '
                                                 'of one hour',
                   'measurementTypeID': 64,
                   'measurementTypeName': 'Output Power',
                   'measurementTypePrecision': 2,
                   'measurementTypeSequenceNo': 259,
                   'measurementTypeUnitGroupID': 5,
                   'measurementTypeUnitGroupName': None,
                   'measurementValue': '30.0000',
                   'qualityFlag': 'NotValidated',
                   'timeStamp': '2018-01-14T16:23:45',
                   'uniqueID': '1234abcd-1a2b-3c4d-5d6f-abcd1234ffff'},
                  {'enableDataValidation': False,
                   'healthStatus': {'healthCode': 'Undefined',
                                    'healthColor': None},
                   'isCalibrationEnabled': False,
                   'isCumulative': False,
                   'isEditable': False,
                   'isHealthParameter': False,
                   'isVisible': True,
                   'measurementCalibration': None,
                   'measurementTypeCode': 'RegreasingAdvice',
                   'measurementTypeDescription': 'Remaining time until the '
                                                 'motor needs to be greased, '
                                                 'based on the original '
                                                 'recommendation of the '
                                                 'manufacturer, adjusted for '
                                                 'real operation, speed and '
                                                 'operating hours.',
                   'measurementTypeID': 65,
                   'measurementTypeName': 'Regreasing Advice',
                   'measurementTypePrecision': 0,
                   'measurementTypeSequenceNo': 260,
                   'measurementTypeUnitGroupID': 13,
                   'measurementTypeUnitGroupName': None,
                   'measurementValue': None,
                   'qualityFlag': 'NotValidated',
                   'timeStamp': None,
                   'uniqueID': None},
                  {'enableDataValidation': False,
                   'healthStatus': {'healthCode': 'Undefined',
                                    'healthColor': '#A5B6B9'},
                   'isCalibrationEnabled': False,
                   'isCumulative': False,
                   'isEditable': False,
                   'isHealthParameter': True,
                   'isVisible': True,
                   'measurementCalibration': None,
                   'measurementTypeCode': 'MotorMisalignment',
                   'measurementTypeDescription': 'Simple True/False indicator '
                                                 'to show if the motor is '
                                                 'subject to misalignment or '
                                                 'not. There is no indication '
                                                 'for how serious the '
                                                 'misalignment is, nor by how '
                                                 'much the motor is out of '
                                                 'alignment.',
                   'measurementTypeID': 66,
                   'measurementTypeName': 'Simple Misalignment',
                   'measurementTypePrecision': 0,
                   'measurementTypeSequenceNo': 229,
                   'measurementTypeUnitGroupID': 0,
                   'measurementTypeUnitGroupName': None,
                   'measurementValue': None,
                   'qualityFlag': 'NotValidated',
                   'timeStamp': None,
                   'uniqueID': None},
                  {'enableDataValidation': False,
                   'healthStatus': {'healthCode': 'Undefined',
                                    'healthColor': None},
                   'isCalibrationEnabled': False,
                   'isCumulative': False,
                   'isEditable': False,
                   'isHealthParameter': False,
                   'isVisible': True,
                   'measurementCalibration': None,
                   'measurementTypeCode': 'MotorStartStopCount',
                   'measurementTypeDescription': None,
                   'measurementTypeID': 67,
                   'measurementTypeName': 'Nr. Of Starts Between Measurements',
                   'measurementTypePrecision': 0,
                   'measurementTypeSequenceNo': 254,
                   'measurementTypeUnitGroupID': 0,
                   'measurementTypeUnitGroupName': None,
                   'measurementValue': None,
                   'qualityFlag': 'NotValidated',
                   'timeStamp': None,
                   'uniqueID': None}],
 'organization': {'isPrivateOrgarnization': False,
                  'organizationID': 1234,
                  'organizationName': 'Tasty Manufacturing'},
 'plantID': 5678,
 'plantName': 'Food Factory',
 'sensor': {'commissioningDate': '2018-01-12T16:23:45.931',
            'features': [{'featureKey': 'BatteryLevel',
                          'featureKeySequenceNo': 401,
                          'featureName': 'Battery Level',
                          'featureValue': 3.4567,
                          'isVisible': False,
                          'timeStamp': '2018-01-12T16:23:45'},
                         {'featureKey': 'ShockDetection',
                          'featureKeySequenceNo': 403,
                          'featureName': 'Shock Detection',
                          'featureValue': None,
                          'isVisible': False,
                          'timeStamp': '2018-01-12T16:23:45'},
                         {'featureKey': 'SensorSelfTest',
                          'featureKeySequenceNo': 405,
                          'featureName': 'Sensor Self Test',
                          'featureValue': None,
                          'isVisible': False,
                          'timeStamp': '2018-01-12T16:23:45'},
                         {'featureKey': 'SensorMeasurementInterval',
                          'featureKeySequenceNo': 412,
                          'featureName': 'Measurement Interval',
                          'featureValue': 15.0,
                          'isVisible': True,
                          'timeStamp': '2018-01-12T16:23:45'},
                         {'featureKey': 'BatteryPercentage',
                          'featureKeySequenceNo': 414,
                          'featureName': 'Battery Status',
                          'featureValue': 15.421,
                          'isVisible': True,
                          'timeStamp': '2018-01-12T16:23:45.931'}],
            'firmwareVersion': '8.7',
            'hardware': {'hardwareRevisionID': 3,
                         'hardwareRevisionName': 'F',
                         'hardwareVarianceID': 1,
                         'hardwareVarianceName': 'HardwareVariance_Motor'},
            'properties': [{'propertyDataType': 'String',
                            'propertyIsVisible': True,
                            'propertyKey': 'MAC',
                            'propertyKeySequenceNo': 301,
                            'propertyName': 'MAC',
                            'propertyValue': '50:31:AD:12:13:14'},
                           {'propertyDataType': 'DateTime',
                            'propertyIsVisible': False,
                            'propertyKey': 'ShippedOn',
                            'propertyKeySequenceNo': 302,
                            'propertyName': 'Shipped On',
                            'propertyValue': '02/13/2018 00:00:00.000'},
                           {'propertyDataType': 'String',
                            'propertyIsVisible': False,
                            'propertyKey': 'CustomerNumber',
                            'propertyKeySequenceNo': 303,
                            'propertyName': 'Customer Number',
                            'propertyValue': 'R&D_TEST_REV_Z'},
                           {'propertyDataType': 'DateTime',
                            'propertyIsVisible': False,
                            'propertyKey': 'WarrantyStartDate',
                            'propertyKeySequenceNo': 304,
                            'propertyName': 'Warranty Start Date',
                            'propertyValue': '02/13/2018 00:00:00.000'},
                           {'propertyDataType': 'DateTime',
                            'propertyIsVisible': False,
                            'propertyKey': 'WarrantyEndDate',
                            'propertyKeySequenceNo': 305,
                            'propertyName': 'Warranty End Date',
                            'propertyValue': '02/13/2020 00:00:00.000'},
                           {'propertyDataType': 'String',
                            'propertyIsVisible': True,
                            'propertyKey': 'ChipID',
                            'propertyKeySequenceNo': 306,
                            'propertyName': 'Chip ID',
                            'propertyValue': '12345678abcdefff'},
                           {'propertyDataType': 'String',
                            'propertyIsVisible': False,
                            'propertyKey': 'AuthenticationID',
                            'propertyKeySequenceNo': 308,
                            'propertyName': 'AuthenticationID',
                            'propertyValue': None},
                           {'propertyDataType': 'Boolean',
                            'propertyIsVisible': False,
                            'propertyKey': 'MicTestFailed',
                            'propertyKeySequenceNo': 309,
                            'propertyName': 'Mic Test Failed',
                            'propertyValue': '1'}],
            'sensorIdentifier': 'S2A0000001-ABCD',
            'subscription': {'endDate': '2020-01-12T16:23:45.931',
                             'hasAvailableSubscriptions': True,
                             'isBasicSubscription': False,
                             'isTrialSubscription': False,
                             'startDate': '2018-01-12T16:23:45.931',
                             'subscriptionLevel': {'description': 'Cloud '
                                                                  'Interface',
                                                   'id': 4,
                                                   'name': 'SmartSensorMotor_CloudInterface'}}},
 'sensorIdentifier': 'S2A0000001-ABCD',
 'sensorTypeID': 1,
 'serialNumber': '78',
 'siteIdentifier': None,
 'uniqueID': '1234abcd-1a2b-3c4d-5d6f-abcd1234ffff'}

Settings

If you have not configured your credentials in the settings.yaml file in the root folder, the program will ask you to input your username, password, or API key.