Update Specific Sensor API

Require Authentication

This API is used to update specific sensor for the company based on combination of deviceID and token.

URL

api/sensors/update/:sensorsID

Required parameter (in URL)

:sensorsID «contains sensorsID that want to be updated. It must be put in the URL, e.g: api/sensors/update/1»

Required parameter (POST)

deviceID
token

Optional parameter

sensorName «contains sensor custom name. If passed, value should not be empty»
sensorstokenID «contains sensorstokenID. If passed, sensorDeviceID must be passed too, and this value, combined with sensorDeviceID (new sensorDeviceID passed in this event), must be unique in our system and must exist in vendor's or manufacturer's database. To get the sensorstokenID, please see Get Available Sensor Manufacturers»
sensorDeviceID «contains sensor device ID / serial number. If passed, sensorstokenID must be passed too, and this value, combined with sensorstokenID (new sensorstokenID passed in this event), must be unique in our system and must exist in vendor's or manufacturer's database. So if any user from any company already use the device ID, other users can't add the same»
description
firmwareVersion
connectivityType «contains connectivity type of the sensor.('LORAWAN AS923','NB-IOT','CATM1','SIGFOX','WI-FI','3G','LORAWAN AU915') »
simCardNumber «contains sim card number of the sensor. »
connectivityProvider «contains connectivity provider of the sensor. ('M2M', 'Vodafone', 'Telstra','Meshed', 'NNNCo','Thinkxtra') »
encryption_key
encryption
IMEI
IMSI
flashEncryptionKey
secureBootKey
AESGCMKey
RPCUnlockCode
loRaAppEUI
loRaAppKey
AssetSerial1
AssetSerial2

Example JSON Payload

{
  "deviceID": "ABCD-EFGH-IJKL-MNOP",
  "token": "2b6f3fc034d61fcbb75e52a9aab0c819",
  "sensorName": "SensorName"
}

Possible return HTTP status code

Return message

{
  "status": "success",
  "message": {
    "sensorsID": 479,
    "sensorstokenID": 3,
    "sensorCompany": "SmartsensorNew",
    "sensorDeviceID": "aaaaaaaaaaaaaaab",
    "firmwareVersion": "",
    "sensorName": "SensorName",
    "isAllocated": "Y",
    "description": "",
    "heartbeatFrequency": 0,
    "companyID": 16,
    "createdDate": 1557290069,
    "updatedDate": 1692283615,
    "createdByUserID": 5,
    "updatedByUserID": 90,
    "connectivityType": "LORAWAN AS923",
    "simCardNumber": "",
    "connectivityProvider": "Actility",
    "encryption": "N",
    "latest_sensorsdata": {
      "sensorsdataID": 21547633,
      "sensorallocation": {
        "projectpinID": 1758,
        "projectID": 152,
        "projectName": "Zone 2",
        "projectgroupID": 0,
        "groupName": "",
        "iconType": "pintype",
        "iconID": 2,
        "iconURL": "https://dashboard.superfy.com/assets/images/icons/default/appsize/enclosure.png",
        "customlocationID": 0,
        "locationName": "",
        "pinAddress1": "",
        "pinAddress2": "",
        "pinCity": "",
        "pinState": "",
        "pinCountry": "",
        "pinZipCode": "",
        "latitude": -6.159944542411,
        "longitude": 106.80634114891,
        "name": "Designworks Test device",
        "description": "",
        "serialNumber": "",
        "assetTag": [
          {
              "pinstagsID": 65,
              "tags_text": "test tag param"
          },
          {
              "pinstagsID": 69,
              "tags_text": "Ualla"
          }
        ],
        "manufacturerID": 0,
        "manufacturerName": "",
        "createdDate": 1614829167,
        "creatorUserID": 90,
        "pinType": {
          "pintypeID": 134,
          "pinTypeName": "bb test",
          "iconType": "system",
          "iconID": 2,
          "iconURL": "2",
          "pinTypeDescription": "",
          "pinTypeImageOriginalName": "",
          "pinTypeImageURL": "",
          "manufacturerID": 0,
          "manufacturerName": "0",
          "pinTypeCreatedDate": 1591353799,
          "pinTypeCreatedByUserID": 90,
          "pinTypeModifiedDate": 1614829214,
          "pinTypeModifiedByUserID": 90,
          "depthWhenEmpty_cm": 20,
          "distanceSensorToFillLine_cm": 2,
          "total_projectpins": 33
        }
      },
      "sensorEventID": "",
      "sensorDeviceID": "aaaaaaaaaaaaaaab",
      "firmwareVersion": "",
      "headerMethod": "heartbeat",
      "reason": "SAMPLE_PERIOD",
      "temperatureExist": "Y",
      "temperatureValue": 720,
      "temperatureOkay": "N",
      "accelerometer_x": 0,
      "accelerometer_y": 0,
      "accelerometer_z": -0.649999976158,
      "ultrasoundExist": "Y",
      "ultrasound": 59,
      "batteryLevel": 100,
      "signalStrengthExist": "Y",
      "signalStrength_rssi_dbm": -93,
      "signalStrength_bitErrorRate": 0,
      "laserDistance1": 112,
      "laserDistance2": 118,
      "averageDistance": 96,
      "laserAverageDistance": 115,
      "timestampdata": 1673881939
    },
    "fillLevelSource": "laseravg"
  }
}

Note:
"latest_sensorsdata" may have null value if there is no latest sensor data.
"currentPinAllocated", "latest_sensorsdata", and "sensorallocation" might be null if there is no data

Superfy Platform API Documentation