Décodage des payloads - Community Edition

Décodage des payloads - Community Edition

  2. // Decoder function for Heywaste Fill Level Sensor (community edition)
  3. // working with EU868
  4. // https://www.heyliot.com
  5. //

  7. // Your container configuration is stored here, you can pull it from your database...
  8. const containerConfiguration = {
  9.     maxMeasure: 3000, // measure when container is empty = container depth (in millimeters)
  10.     minMeasure: 0 // measure when container is full (in millimeters)
  11. };

  13. //This object will be filled by the payloadDecoder function
  14. let decodedPayload = {
  15.     payloadType: null,
  16.     nbrMeasure: null,
  17.     measure: null,
  18.     fillLevel: null,
  19.     rangeStatus: null,
  20. };

  22. const extractPayloadType = (payload) => {
  23.     const type = payload.substr(0, 1);

  25.     switch (type) {
  26.         case '1':
  27.         case '3': // Periodic measure will be send in a regular interval according to the sensor configuration
  28.             return "PERIODIC_MEASURE";
  29.         case '2': // Manual measure need a push button
  30.             return "MANUAL_MEASURE"
  31.         case '0': // First uplink - not available in community edition
  32.         case '4': // Daily configuration - not available in community edition
  33.         default:
  34.             return null;
  35.     }
  36. }

  38. /**
  39.  * By default, the sensor will send its measurements in millimeters
  40.  * If you want to estimate a fill level in percentage, you have two options :
  41.  * 1) use the raw measure in millimeters and calculate the fill level by yourself in your own app or IoT dashboard
  42.  * 2) you can activate the fill level calculation function in this decoder by providing the max measure (= 0% ; container depth in millimeters) and the min measure (= measure when container is full)
  43.  *
  44.  * @param payload {string}
  45.  * @param detectFillLevel {boolean} - If true we are going to d
  46.  */
  47. const payloadDecoder = (payload, detectFillLevel = true) => {

  49.     decodedPayload.payloadType = extractPayloadType(payload);
  50.     decodedPayload.nbrMeasure = parseInt(payload.substr(1, 1));
  51.     decodedPayload.rangeStatus = parseInt(payload.substr(2, 1));
  52.     decodedPayload.measure = parseInt(payload.substr(3, 3), 16) * 2;

  54.     if (detectFillLevel) {
  55.         const maxMeasureOfContainer = containerConfiguration.maxMeasure;
  56.         const minMeasureOfContainer = containerConfiguration.minMeasure;

  58.         const distanceBetweenMinAndMax = maxMeasureOfContainer - minMeasureOfContainer;

  60.         decodedPayload.fillLevel = 100 - Math.round((decodedPayload.measure - minMeasureOfContainer) * 100 / distanceBetweenMinAndMax);
  61.     }

  63.     return decodedPayload;
  64. };

  66. /**
  67.  * You will get outputs :
  68.  *
  69.  * console.log(payload1) -->
  70.  * {
  71.  *   payloadType: 'PERIODIC_MEASURE',
  72.  *   nbrMeasure: 1,
  73.  *   measure: 70,
  74.  *   fillLevel: null,
  75.  *   rangeStatus: 0
  76.  * }
  77.  *
  78.  * console.log(payload2) -->
  79.  * {
  80.  *   payloadType: 'MANUAL_MEASURE',
  81.  *   nbrMeasure: 2,
  82.  *   measure: 70,
  83.  *   fillLevel: 98,
  84.  *   rangeStatus: 0
  85.  * }
  86.  */

  88. const payload1 = payloadDecoder("11023", false);
  89. console.log(payload1);

  91. const payload2 = payloadDecoder("22023");
  92. console.log(payload2);

    • Related Articles

    • Comment s'authentifier

      Si vous souhaitez bénéficier d'une authentification par clé API, vous pouvez en faire la demande à votre contact Heyliot. Si vous bénéficiez déjà d'une clé d'API, cette section ne vous concerne pas. Préambule Le système d'authentification d'Heyliot ...

    • Récupérer les niveaux de remplissages de vos conteneurs

      Récupérer les niveaux de remplissages de vos conteneurs Accédez à la documentation complète de l'API V2 sur https://docs.heyliot.app/?api=v2 On ne parle pas ici de mesure mais bien de niveau de remplissage, depuis le 1er Février 2024, c'est cette ...