Microshare™ Standards

Let's take a look at the Microshare™ data structure.

thumbnail 2


SUMMARY :
  1. Microshare unpacked format
  2. Microshare Standards Data
  3. Standards Data Table
  4. Example

1. Microshare unpacked format


Data is sent as a payload from the IoT devices to the Microshare unpackers as raw, compressed data for efficiency. The data is then transformed and enriched by the Microshare unpacker into comprehensible information using one of our canonical json formats. This process ensures that the data can be analyzed consistently regardless of device vendor or the network used to transmit. The final format is referred to as unpacked data.

This guide will provide details on the processes involved in collecting the raw data and decompressing it into unpacked data. Please note that the information supplied may differ slightly to that required for your network server, as details differ from server to server.

Additionally, this guide will discuss tags. Tags are labels or descriptions attached to your device clusters for ease of identification.

2. Microshare Standards Data


Example :

{
  "meta": {
    "currentCount": 337,
    "currentPage": 1,
    "perPage": 1000,
    "source": "db",
    "totalCount": 1000,
    "totalPages": 1
  },
  "objs": [
    {
      "_id": "5ed1123046e0fb0028b70???",
      "checksum": "09BE84FF7E4E9CF6E4777C9900EDCDE0C0397956F251C8BCF08A5226A387FFA1L1521",
      "createDate": "2020-06-17T09:48:08.980Z",
      "creatorId": "yourname@microshare.io",
      "data": {
        "co2": 65535,
        "co2_label": "65535ppm",
        "co2_unit": "ppm",
        "device": {
          "battery": {
            "power": 80,
            "power_label": "0.8%",
            "voltage": 3.6,
            "voltage_label": "3.6V"
          },
          "id": "58-A0-CB-00-00-40-??-??"
        },
        "humidity": 64,
        "humidity_label": "64%",
        "humidity_unit": "%",
        "ipso": {
          "3302": {
              "5500": false,
              "5751": "PIR"
          },
          "3303": {
              "5700": 19,
              "5701": "Cel"
          },
          "3304": {
              "5700": 64,
              "5701": "%"
          },
          "3316": {
              "5700": 3.6,
              "5701": "V",
              "5750": "device battery state: voltage"
          },
          "3320": {
              "5700": 0.8,
              "5701": "%",
              "5750": "device battery state: percentage charged"
          },
          "3325-1": {
              "5700": 65535,
              "5701": "ppm",
              "5750": "concentration of CO2 in ppm"
          },
          "3325-2": {
              "5700": 65535,
              "5701": "ppb",
              "5750": "concentration of VOCs in ppb"
          }
        },
        "meta": {
          "device": [
            "London Office",
            "1st Floor",
            "Office 3"
          ],
          "global": [
            "Europe",
            "United Kingdom",
            "London",
            "5 Merchant Square",
            "your environment"
          ],
          "iot": {
            "device_id": "58-A0-CB-00-00-40-??-??",
            "fcnt_dwn": 749,
            "fcnt_up": 4510,
            "fport": 103,
            "iso_time": "2020-06-17T09:48:08.494Z",
            "ns_version": "v3.0",
            "payload": "08cb3340ffffffff",
            "payload_fmt": 1,
            "time": "2020-06-17T09:48:08.494Z",
            "type": "uplink"
          },
          "source": []
        },
        "origin": {
          "adr": true,
          "classB": false,
          "confirmed": false,
          "delayed": false,
          "encodingType": "HEXA",
          "encrypted": false,
          "endDevice": {
              "cluster": {
                  "id": 66
              },
              "devAddr": "E04123???",
              "devEui": "58A0CB000040????"
          },
          "fCntDown": 749,
          "fCntUp": 4510,
          "fPort": 103,
          "id": "5ee9e6d860baf40001b9e???",
          "payload": "08cb3340ffffffff",
          "recvTime": 1592387288494
        },
        "status": 8,
        "status_label": "false",
        "temp": 19,
        "temp_label": "19 °C",
        "temp_unit": "°C",
        "unpacker": {
          "class": "io.tracknet.healthy.TBHV100.Decoder",
          "library": "lorawan_device_unpack",
          "version": "0.5.5"
        },
        "voc": 65535,
        "voc_label": "65535ppb",
        "voc_unit": "ppb"
      },
      "desc": "",
      "id": "5ed1123046e0fb0028b70???",
      "name": "",
      "origin": {
        "checksum": "09BE84FF7E4E9CF6E4777C9900EDCDE0C0397956F251C8BCF08A5226A387FFA1L1521",
        "createDate": "2020-06-17T09:48:08.980Z",
        "creatorId": "yourname@microshare.io",
        "desc": "Record of Type io.microshare.yourenvironment.unpacked",
        "id": "5ed1123046e0fb0028b70???",
        "name": "io.microshare.yourenvironment.unpacked",
        "remoteAddress": "your remote address",
        "tokendata": {
          "id": "006f6b5f-171e-46cf-8f70-c4fa15b6????",
          "ip": "your ip address"
        }
      },
      "owner": {
        "appid": "B8E2F5B2-969D-4EFF-BD45-B8CFF2F2????",
        "meta": {},
        "org": "io.microshare",
        "owners": [],
        "user": "yourname@microshare.io"
      },
      "recType": "io.microshare.yourenvironment.unpacked",
      "tags": [
        "Europe",
        "United Kingdom",
        "London",
        "5 Merchant Square",
        "your environment",
        "London Office",
        "1st Floor",
        "Office 3"
      ],
      "tstamp": 1592387288980,
      "updateDate": "2020-06-17T09:48:08.980Z",
      "updaterId": "yourname@microshare.io"
    },

.......

A. General Structure

The majority of the information within the packet of data details the settings of the device cluster. The remaining pieces of information contain the data collected by the devices.

This is how the device cluster is set up:

dc


B. {Data}

Now let’s talk about the {Data}, which contains the device information.

The various components include:

Above is the device data within {Data}.

All these values are explained with their units in the following table:

> Standards Data Table

{Data} contains information about the device that provided the data payload. This usually includes the device id, battery type, battery type, etc. The code supplied will look like:

"device": {
  "battery": {
    "power": 80,
    "power_label": "0.8%",
    "voltage": 3.6,
    "voltage_label": "3.6V"
  },
  "id": "58-A0-CB-00-00-40-??-??"
},

C. Ipso

Micoshare® upholds the IPSO values for cohesion with our international partners. You can learn more about the IPSO IoT standards on this web page:

http://www.openmobilealliance.org/wp/OMNA/LwM2M/LwM2MRegistry.html

D. Meta/IoT

"meta": {
  "device": [
    "London",
    "1st Floor",
    "Office 3"
  ],
  "global": [
    "Europe",
    "United Kingdom",
    "London",
    "5 Merchant Square",
    "your environment"
  ],
  "iot": {
    "device_id": "58-A0-CB-00-00-40-??-??",
    "fcnt_dwn": 749,
    "fcnt_up": 4510,
    "fport": 103,
    "iso_time": "2020-06-17T09:48:08.494Z",
    "ns_version": "v3.0",
    "payload": "08cb3340ffffffff",
    "payload_fmt": 1,
    "time": "2020-06-17T09:48:08.494Z",
    "type": "uplink"
  },
  "source": []
},
The meta will provide:
  • device - the device’s specific location.

  • global - location of the device’s device cluster.

  • device_id - the device’s unique identification number.

  • type - whether the information is an uplink (data is sent from the device up to the network server) or a downlink (data is sent from the network server down to the device). This will almost always be an uplink.

  • fcnt_up - the up count; the number of uplink interactions between the device and the network server.

  • fcnt_down - the down count.

  • fport - the port where the device’s packet is sent to the network server.

  • iso_time or time- the time at which the network received the device’s data.

  • ns_version - the version of the network server.

  • payload - the data that the device sends out to the network server.

E. Origin

"origin": {
  "checksum": "09BE84FF7E4E9CF6E4777C9900EDCDE0C0397956F251C8BCF08A5226A387FFA1L1521",
  "createDate": "2020-06-17T09:48:08.980Z",
  "creatorId": "yourname@microshare.io",
  "desc": "Record of Type io.microshare.yourenvironment.unpacked",
  "id": "5ed1123046e0fb0028b70???",
  "name": "io.microshare.yourenvironment.unpacked",
  "remoteAddress": "your ip address",
  "tokendata": {
    "id": "006f6b5f-171e-46cf-8f70-c4fa15b6????",
    "ip": "your ip address"
  }
},

A thorough explanation of the origins can be found in the Overview page.

Some information may differ if you unpack the data in an account that is not the one hosting the packed data. This is unadvised and be cautious to avoid this mistake.

F. Unpacker

"unpacker": {
  "class": "io.tracknet.healthy.TBHV100.Decoder",
  "library": "lorawan_device_unpack",
  "version": "0.5.5"
},

The last block of data in {Data} describes the device cluster that is permitted to unpack the payload. This is important as Microshare has a large number of unpackers and sending the payload to the wrong unpacker may result in lost information. Below is the library of all the various Microshare unpackers and where it is located. The descriptors ‘class’ and ‘version’ helps navigate this library.

3. Standards Data Table


Name Unit Meaning
temperature °C Temperature of area in degrees celcius
humidity % Percentage of water vapor mass in dry air of area
pressure hpa Pressure of the area
illuminance lx Amount of light in the area
voc ppb How much Volatile Organic Compound in ppb is in the area
co2 ppm Carbon Dioxide Concentration in ppm in area
iaq n/a Indoor Air Quality Index (0-500)
loudness dba Level of Volume of area
haziness % level of impared vision from environment
smokiness %dbm level of smoke in the environment
gas n/a level of gas in the environment
voltage V battery voltage
current A electrical current
multiplier n/a electrical current value multiplier
presence n/a true= presebce detected
motions_since_reset n/a motion since reset
motions_since_transmit n/a motion since last transmit
acceleration m/s2 Acceleration of motion detected
velocity m/s velocity of motion detected
x n/a position on the x- plane
y n/a position on the y- plane
z n/a position on the z- plane
leak n/a true= leak detected
lighter n/a true= lighter
darker n/a true= darker
dismantle n/a true= dismantled
charge % Battery Charge
period s Time in between measurements
rssi dbm Recieved Signal Strength Indication
snr db Signal to Noise Ratio, quality of signal
reports_since_reset n/a number of reports since last reset
closed n/a true= closed
fill % Fill Level frame/Uplink frame
distance cm distance from monitor to device
gps ° GPS Coordinates
lat ° Latitude
lon ° Longitude
push n/a true= button pushed
swipe n/a true= swiped
pushes_since_reset n/a button pushes since reset
alarm n/a true = there is an alarm
time s seconds since 1/1/1970
iso_time s ISO 8601 datetime
seconds_since_change s seconds since last transmit
msg_type n/a Type of message recieved
fault n/a number of faults detected in payload

4. Example


A. Motion Data

{
    "meta": {
        "currentCount": 355,
        "currentPage": 1,
        "perPage": 1000,
        "source": "db",
        "totalCount": 1000,
        "totalPages": 1
    },
    "objs": [
        {
            "_id": "5eea1d8d46e0fb0028a0b???",
            "checksum": "8BAA297C7FC219B1EFFA2846C5B9C9EZE34CAC3671A7D3AF90C89CEC5DAABC2L1425",
            "createDate": "2020-06-17T13:41:33.425Z",
            "creatorId": "yourname@microshare.io",
            "data": {
                "device": {
                    "battery": {
                        "power": 0.8,
                        "power_label": "80%",
                        "voltage": 3.6,
                        "voltage_label": "3.6V"
                    },
                    "count": 2997,
                    "id": "58-A0-CB-00-00-22-??-??"
                },
                "ipso": {
                    "3000": {
                        "5534": 2997,
                        "5750": "count of reports since power-on"
                    },
                    "3302": {
                        "5500": true,
                        "5750": "TRUE = presence detected",
                        "5751": "PIR"
                    },
                    "3303": {
                        "5700": 25,
                        "5701": "Cel"
                    },
                    "3316": {
                        "5700": 3.6,
                        "5701": "V",
                        "5750": "device battery state: voltage"
                    },
                    "3320": {
                        "5700": 0.8,
                        "5701": "%",
                        "5750": "device battery state: percentage charged"
                    },
                    "3333": {
                        "5707": 0,
                        "5750": "seconds elapsed since last state change"
                    }
                },
                "meta": {
                    "device": [
                        "London Office",
                        "Ground Floor",
                        "Office 2"
                    ],
                    "global": [
                        "Europe",
                        "United Kingdom",
                        "London",
                        "5 Merchant Square",
                        "door"
                    ],
                    "iot": {
                        "device_id": "58-A0-CB-00-00-22-??-??",
                        "fcnt_dwn": 761,
                        "fcnt_up": 5551,
                        "fport": 102,
                        "iso_time": "2020-06-17T13:41:32.967Z",
                        "ns_version": "v3.0",
                        "payload": "01cb390000b50b00",
                        "payload_fmt": 1,
                        "time": "2020-06-17T13:41:32.967Z",
                        "type": "uplink"
                    },
                    "source": []
                },
                "origin": {
                    "adr": true,
                    "classB": false,
                    "confirmed": false,
                    "delayed": false,
                    "encodingType": "HEXA",
                    "encrypted": false,
                    "endDevice": {
                        "cluster": {
                            "id": 84
                        },
                        "devAddr": "00000???",
                        "devEui": "58A0CB000022????"
                    },
                    "fCntDown": 761,
                    "fCntUp": 5551,
                    "fPort": 102,
                    "id": "5eea1d8d60baf40001ba2???",
                    "payload": "01cb390000b50b00",
                    "recvTime": 1592401292967
                },
                "payload": "01cb390000b50b00",
                "status": 1,
                "status_label": "occupied",
                "temp": 25,
                "temp_label": "25°C",
                "temp_unit": "°C",
                "time": 0,
                "time_label": "0 minutes",
                "time_unit": "minutes",
                "unpacker": {
                    "class": "io.tracknet.motion.TMBS100.Decoder",
                    "library": "lorawan_device_unpack",
                    "version": "0.5.5"
                }
            },
            "desc": "",
            "id": "5eea1d8d46e0fb0028a0b???",
            "name": "",
            "origin": {
                "checksum": "8BAA297C7FC219B1EFFA2846C5B9C9C2BF56CAC3671A7D3AF90C89CEC5DAABC2L1425",
                "createDate": "2020-06-17T13:41:33.425Z",
                "creatorId": "yourname@microshare.io",
                "desc": "Record of Type io.microshare.motion.unpacked",
                "id": "5eea1d8d46e0fb0028a0b???",
                "name": "io.microshare.motion.unpacked",
                "remoteAddress": "your remote address",
                "tokendata": {
                  "id": "006f6b5f-171e-46cf-8f70-c4fa15b6????",
                  "ip": "your ip address"
                }
            },
            "owner": {
                "appid": "B8E2F5B2-969D-4EFF-BD45-B8CFF2F2????",
                "meta": {},
                "org": "io.microshare",
                "owners": [],
                "user": "yourname@microshare.io"
            },
            "recType": "io.microshare.motion.unpacked",
            "tags": [
                "Europe",
                "United Kingdom",
                "London",
                "5 Merchant Square",
                "door",
                "London Office",
                "Ground Floor",
                "Office 2"
            ],
            "tstamp": 1592401293425,
            "updateDate": "2020-06-17T13:41:33.425Z",
            "updaterId": "yourname@microshare.io"
        },

B. Temperature Data

{
  "meta": {
    "currentCount": 337,
    "currentPage": 1,
    "perPage": 1000,
    "source": "db",
    "totalCount": 1000,
    "totalPages": 1
  },
  "objs": [
    {
      "_id": "5ed1123046e0fb0028b70???",
      "checksum": "09BE84FF7E4E9CF6E4777C9900EDCDE0C0397956F251C8BCF08A5226A387FFA1L1521",
      "createDate": "2020-06-17T09:48:08.980Z",
      "creatorId": "yourname@microshare.io",
      "data": {
        "co2": 65535,
        "co2_label": "65535ppm",
        "co2_unit": "ppm",
        "device": {
          "battery": {
            "power": 80,
            "power_label": "0.8%",
            "voltage": 3.6,
            "voltage_label": "3.6V"
          },
          "id": "58-A0-CB-00-00-40-??-??"
        },
        "humidity": 64,
        "humidity_label": "64%",
        "humidity_unit": "%",
        "ipso": {
          "3302": {
              "5500": false,
              "5751": "PIR"
          },
          "3303": {
              "5700": 19,
              "5701": "Cel"
          },
          "3304": {
              "5700": 64,
              "5701": "%"
          },
          "3316": {
              "5700": 3.6,
              "5701": "V",
              "5750": "device battery state: voltage"
          },
          "3320": {
              "5700": 0.8,
              "5701": "%",
              "5750": "device battery state: percentage charged"
          },
          "3325-1": {
              "5700": 65535,
              "5701": "ppm",
              "5750": "concentration of CO2 in ppm"
          },
          "3325-2": {
              "5700": 65535,
              "5701": "ppb",
              "5750": "concentration of VOCs in ppb"
          }
        },
        "meta": {
          "device": [
            "London",
            "1st Floor",
            "Office 3"
          ],
          "global": [
            "Europe",
            "United Kingdom",
            "London",
            "5 Merchant Square",
            "your environment"
          ],
          "iot": {
            "device_id": "58-A0-CB-00-00-40-??-??",
            "fcnt_dwn": 749,
            "fcnt_up": 4510,
            "fport": 103,
            "iso_time": "2020-06-17T09:48:08.494Z",
            "ns_version": "v3.0",
            "payload": "08cb3340ffffffff",
            "payload_fmt": 1,
            "time": "2020-06-17T09:48:08.494Z",
            "type": "uplink"
          },
          "source": []
        },
        "origin": {
          "adr": true,
          "classB": false,
          "confirmed": false,
          "delayed": false,
          "encodingType": "HEXA",
          "encrypted": false,
          "endDevice": {
              "cluster": {
                  "id": 66
              },
              "devAddr": "E04123???",
              "devEui": "58A0CB000040????"
          },
          "fCntDown": 749,
          "fCntUp": 4510,
          "fPort": 103,
          "id": "5ee9e6d860baf40001b9e???",
          "payload": "08cb3340ffffffff",
          "recvTime": 1592387288494
        },
        "status": 8,
        "status_label": "false",
        "temp": 19,
        "temp_label": "19 °C",
        "temp_unit": "°C",
        "unpacker": {
          "class": "io.tracknet.healthy.TBHV100.Decoder",
          "library": "lorawan_device_unpack",
          "version": "0.5.5"
        },
        "voc": 65535,
        "voc_label": "65535ppb",
        "voc_unit": "ppb"
      },
      "desc": "",
      "id": "5ed1123046e0fb0028b70???",
      "name": "",
      "origin": {
        "checksum": "09BE84FF7E4E9CF6E4777C9900EDCDE0C0397956F251C8BCF08A5226A387FFA1L1521",
        "createDate": "2020-06-17T09:48:08.980Z",
        "creatorId": "yourname@microshare.io",
        "desc": "Record of Type io.microshare.yourenvironment.unpacked",
        "id": "5ed1123046e0fb0028b70???",
        "name": "io.microshare.yourenvironment.unpacked",
        "remoteAddress": "your remote address",
        "tokendata": {
          "id": "006f6b5f-171e-46cf-8f70-c4fa15b6????",
          "ip": "your ip address"
        }
      },
      "owner": {
        "appid": "B8E2F5B2-969D-4EFF-BD45-B8CFF2F2????",
        "meta": {},
        "org": "io.microshare",
        "owners": [],
        "user": "yourname@microshare.io"
      },
      "recType": "io.microshare.your environment.unpacked",
      "tags": [
        "Europe",
        "United Kingdom",
        "London",
        "5 Merchant Square",
        "your environment",
        "London",
        "1st Floor",
        "Office 3"
      ],
      "tstamp": 1592387288980,
      "updateDate": "2020-06-17T09:48:08.980Z",
      "updaterId": "yourname@microshare.io"
    },

.......

C. Feedback Data

{
    "meta": {
        "currentCount": 261,
        "currentPage": 1,
        "perPage": 1000,
        "source": "db",
        "totalCount": 1000,
        "totalPages": 1
    },
    "objs": [
        {
            "_id": "5eea1e1346e0fb0022355???",
            "checksum": "C6E1072EB86D537C2E7E9B8D3A3244BA4FC5BEDD44718F32532ZZER5E6A56E28F9L1818",
            "createDate": "2020-06-17T13:43:47.365Z",
            "creatorId": "yourname@microshare.io",
            "data": {
                "count_1": 75,
                "count_2": 610,
                "count_3": 42,
                "count_4": 246,
                "count_5": 882,
                "device": {
                    "id": "70-B3-D5-32-60-00-??-??"
                },
                "ipso": {
                    "10241": {
                        "5905": "skiply.eu",
                        "5906": "Smilio Action",
                        "5908": "1.2.0.1"
                    },
                    "3302": {
                        "5500": false,
                        "5751": "Hall Effect activated"
                    },
                    "3347": [
                        {
                            "5501": 75,
                            "5502": false,
                            "5527": "Button #1, Upper Left, count of reports since power-on/reset",
                            "5750": "Push Button",
                            "5853": "Button #1, Upper Left"
                        },
                        {
                            "5501": 610,
                            "5502": false,
                            "5527": "Button #2, Upper Right, count of reports since power-on/reset",
                            "5750": "Push Button",
                            "5853": "Button #2, Upper Right"
                        },
                        {
                            "5501": 42,
                            "5502": false,
                            "5527": "Button #3, Lower Left, count of reports since power-on/reset",
                            "5750": "Push Button",
                            "5853": "Button #3, Lower Left"
                        },
                        {
                            "5501": 246,
                            "5502": false,
                            "5527": "Button #4, Lower Right, count of reports since power-on/reset",
                            "5750": "Push Button",
                            "5853": "Button #4, Lower Right"
                        },
                        {
                            "5501": 882,
                            "5502": false,
                            "5527": "Button #5, Middle, count of reports since power-on/reset",
                            "5750": "Push Button",
                            "5853": "Button #5, Middle"
                        }
                    ]
                },
                "meta": {
                    "device": [
                        "London Office",
                        "1st Floor",
                        "Kitchen"
                    ],
                    "global": [
                        "Europe",
                        "United Kingdom",
                        "London",
                        "5 Merchant Square",
                        "5b_feedback"
                    ],
                    "iot": {
                        "device_id": "70-B3-D5-32-60-00-??-??",
                        "fcnt_dwn": 28,
                        "fcnt_up": 1778,
                        "fport": 2,
                        "iso_time": "2020-06-17T13:43:46.924Z",
                        "ns_version": "v3.0",
                        "payload": "02004b02620372002a00f6",
                        "payload_fmt": 1,
                        "time": "2020-06-17T13:43:46.924Z",
                        "type": "uplink"
                    },
                    "source": []
                },
                "origin": {
                    "adr": true,
                    "classB": false,
                    "confirmed": false,
                    "delayed": false,
                    "encodingType": "HEXA",
                    "encrypted": false,
                    "endDevice": {
                        "cluster": {
                            "id": 2
                        },
                        "devAddr": "E0423???",
                        "devEui": "70B3D5326000C???"
                    },
                    "fCntDown": 28,
                    "fCntUp": 1778,
                    "fPort": 2,
                    "id": "5eea1e1360baf40001ba2???",
                    "payload": "02004b02620372002a00f6",
                    "recvTime": 1592401426924
                },
                "payload": "02004b02620372002a00f6",
                "trigger": false,
                "unpacker": {
                    "class": "eu.skiply.button.SmilioAction.Decoder",
                    "library": "lorawan_device_unpack",
                    "version": "0.5.5"
                }
            },
            "desc": "",
            "id": "5eea1e1346e0fb0028915???",
            "name": "",
            "origin": {
                "checksum": "C6E1072EB86D537C2E7E9B8D3ACREZERT3BEDD44718F9898C234352A56E28F9L1818",
                "createDate": "2020-06-17T13:43:47.365Z",
                "creatorId": "yourname@microshare.io",
                "desc": "Record of Type io.microshare.feedback.unpacked",
                "id": "5eea1e1346e0fb0028915???",
                "name": "io.microshare.feedback.unpacked",
                "remoteAddress": "your remote address",
                "tokendata": {
                  "id": "006f6b5f-171e-46cf-8f70-c4fa15b6????",
                  "ip": "your ip address"
                }
            },
            "owner": {
                "appid": "B8E2F5B2-969D-4EFF-BD45-B8CFF2F2????",
                "meta": {},
                "org": "io.microshare",
                "owners": [],
                "user": "yourname@microshare.io"
            },
            "recType": "io.microshare.feedback.unpacked",
            "tags": [
                "Europe",
                "United Kingdom",
                "London",
                "5 Merchant Square",
                "5b_feedback",
                "London Office",
                "1st Floor",
                "Kitchen"
            ],
            "tstamp": 1592401427365,
            "updateDate": "2020-06-17T13:43:47.365Z",
            "updaterId": "yourname@microshare.io"
        },

D. Contact Tracing

  {
    "meta": {
        "currentCount": 1,
        "currentPage": 1,
        "perPage": 1,
        "source": "db",
        "totalCount": 1,
        "totalPages": 1
    },
    "objs": [
        {
            "_id": "5ee136f146e0fb00282cb???",
            "checksum": "8E6E2AD84157FA0E152B0AD419FB5290ED54808139E67A98F76116B8C0CC51EAL825",
            "createDate": "2020-06-10T19:39:29.798Z",
            "creatorId": "yourname@microshare.io",
            "data": {
                "averageRSSI": -89,
                "detectedDevice": "000003BAB???",
                "device": {
                    "id": "AC233F664???"
                },
                "duration": 3,
                "endTime": "2020-06-10T19:37:28.331Z",
                "locationBeacon": true,
                "meta": {
                    "device": {},
                    "iot": {
                        "device_id": "AC233F664???"
                    },
                    "source": {
                        "device": [
                            "Wokingham",
                            "Ground",
                            "Lounge",
                            ""
                        ],
                        "global": [],
                        "iot": {
                            "device_id": "70-76-FF-00-69-04-??-??",
                            "fcnt_dwn": 5,
                            "fcnt_up": 347,
                            "fport": 95,
                            "ns_version": "v3.0",
                            "payload": "a16176818346ac233f6644ab190b4e8b851831437cbf000604358500433406000605348500432f00000806308500430200000805348500430100000804358500430100000301368500430100000403358500430300000605318500440163fa0009063585004401560000080631850043190000050334",
                            "payload_fmt": 1,
                            "time": "2020-06-10T19:39:28.331Z",
                            "type": "uplink"
                        },
                        "source": []
                    }
                },
                "originatingDevice": "AC233F664???",
                "originatingDeviceBattery": 2.894,
                "start": 5,
                "startTime": "2020-06-10T19:34:28.331Z"
            },
            "desc": "",
            "id": "5ee136f146e0fb00282cb???",
            "name": "",
            "origin": {
                "checksum": "8E6E2AD84157FA0E152B0AD419FB5290ED54808139E67A98F76116B8C0CC51EAL825",
                "createDate": "2020-06-10T19:39:29.798Z",
                "creatorId": "yourname@microshare.io",
                "desc": "Record of Type io.microshare.contact.unpacked.event",
                "id": "5ee136f146e0fb00282cb???",
                "name": "io.microshare.contact.unpacked.event",
                "remoteAddress": "000.00.00.000",
                "tokendata": {
                    "id": "a1c1541d-3a3d-4255-951a-499311c5e???",
                    "ip": "000.00.00.000"
                }
            },
            "owner": {
                "appid": "51C54CDB-D278-4CFD-B8378EF13462E???",
                "org": "io.microshare",
                "owners": [],
                "user": "yourname@microshare.io"
            },
            "recType": "io.microshare.contact.unpacked.event",
            "tags": [
                "Wokingham",
                "Ground",
                "Lounge"
            ],
            "tstamp": 1591817969798,
            "updateDate": "2020-06-10T19:39:29.798Z",
            "updaterId": "yourname@microshare.io"
        }
    ]
}
{
    "event_type":"create",
    "id":"5edfb7e246e0fb00297b5???",
    "obj":{
        "checksum":"E418D6462C167B01655652EA9F0987D42490DBFABBBDD64EFA324A384A3394C3L1496",
        "createDate":1591719906298,
        "creatorId":"yourname@microshare.io",
        "data":{
            "averageRSSI":-6,
            "detectedDevice":"C96E9E87F???",
            "duration":11,
            "endTime":"2020-05-07T14:41:00.000Z",
            "locationBeacon":false,
            "originatingDevice":"EEA0E0E2D???",
            "originatingDeviceBattery":"2.658V",
            "start":5,
            "startTime":"2020-05-07T14:35:00.000Z",
            "device":{
                "id":"EEA0E0E2D???"
            },
            "meta":{
                "device":{

                },
                "iot":{
                    "device_id":"EEA0E0E2D???"
                },
                "source":{
                    "device":[
                        "Location1",
                        "Location2",
                        "Location3",
                        "Location4"
                    ],
                    "global":[
                        "GlobalTag1",
                        "GlobalTag2",
                        "GlobalTag3",
                        "GlobalTag4"
                    ],
                    "iot":{
                        "device_id":"70-76-FF-00-69-04-??-??",
                        "fcnt_dwn":1,
                        "fcnt_up":79,
                        "fport":85,
                        "iso_time":"2020-06-09T19:47:39.185Z",
                        "ns_version":"v3.0",
                        "payload":"a16162958346a0e6f8a0c537350083460b3c470150923200834170340083410433008342746e3100834104340083410531008341013400834101330083419631008346185318127e423600834610e4d899208b300083460897b3c3ac4a3300834603b21606e77035008346069f0f8d92003200834604124eca6ea426008346034325f968da3300834601c64aac0f57310083460df476b95daa320083452a01caba0d29008341812600",
                        "payload_fmt":1,
                        "time":"2020-06-04T19:30:00.185Z",
                        "type":"uplink"
                    },
                    "source":[

                    ]
                }
            }
        },
        "desc":"",
        "id":"5edfb7e246e0fb00297b5???",
        "name":"",
        "origin":{
            "checksum":"E418D6462C167B01655652EA9F0987D42490DBFABBBDD64EFA324A384A3394C3L1496",
            "createDate":"2020-06-09T16:25:06.298Z",
            "creatorId":"yourname@microshare.io",
            "desc":"Record of Type io.microshare.contact.unpacked.event",
            "id":"5edfb7e246e0fb00297b5???",
            "name":"io.microshare.contact.unpacked.event",
            "remoteAddress":"113.90.8.233",
            "tokendata":{
                "id":"5d548231-7b91-4040-bff6-ad4a92ee3???",
                "ip":"000.00.00.000"
            }
        },
        "owner":{
            "appid":"51C54CDB-D278-4CFD-B8378EF13462E???",
            "meta":{

            },
            "org":"io.microshare",
            "owners":[

            ],
            "user":"yourname@microshare.io"
        },
        "recType":"io.microshare.contact.unpacked.event",
        "tags":[
            "Europe",
            "Ireland",
            "Leinster",
            "Dublin"
        ],
        "tstamp":1591719906298,
        "updaterId":"yourname@microshare.io"
    },
    "obj_type":"objs",
    "recType":"io.microshare.contact.unpacked.event",
    "source":"ShareService"
}

E. Asset Zoning

See below the code for more detail on the meaning of the different fields.

  {
        "_id": "5fb54be9a401e8001d80c7fb",
        "checksum": "AC23F16DDC3330223DEC3AE9B60DF4FC03BC9CD633A07294BF1BE2B97D9E5BA7L633",
        "createDate": "2020-10-17T16:29:29.769Z",
        "creatorId": "admin@microshare.io",
        "data": {
          "device": {
            "id": "AC754B6636BC"
          },
          "event": "confirm",
          "external_id": "",
          "meta": {
            "device": [
              "Machine",
              "Xray",
              "Xray1"
            ],
            "iot": {
              "device_id": "AC754B6636BC"
            },
            "source": {
              "device": [
                "Main Building",
                "First Floor",
                "Entrance",
                ""
              ],
              "global": [
                "UK",
                "London",
                "West Hill",
                "Asset Zoning"
              ],
              "iot": {
                "device_id": "78-70-EE-00-69-04-02-50",
                "fcnt_dwn": 12694,
                "fcnt_up": 12841,
                "fport": 85,
                "ns_version": "v3.0",
                "payload": "a1616381831ab76eda4f3600",
                "payload_fmt": 1,
                "time": "2020-10-17T16:29:29.172Z",
                "type": "uplink"
              },
              "source": []
            }
          },
          "movement": false,
          "signal": {
            "unit": "rssi",
            "value": -93
          },
          "time": "2020-10-17T16:29:29.172Z"
        },
        "desc": "",
        "id": "5fb54be9a401e8001d80c7fb",
        "name": "",
        "origin": {
          "checksum": "AC23F16DDC3330223DEC3AE9B60DF4FC03BC9CD633A07294BF1BE2B97D9E5BA7L633",
          "createDate": "2020-10-17T16:29:29.769Z",
          "creatorId": "admin@microshare.io",
          "desc": "Record of Type io.microshare.zoning.unpacked.mock.event",
          "id": "5fb54be9a401e8001d80c7fb",
          "name": "io.microshare.zoning.unpacked.mock.event",
          "remoteAddress": "",
          "tokendata": {
            "id": "",
            "ip": ""
          }
        },
        "owner": {
          "appid": "51C54CDB-D278-4CFD-B8378EF13462E5FB",
          "org": "io.microshare",
          "owners": [],
          "user": "admin@microshare.io"
        },
        "recType": "io.microshare.zoning.unpacked.mock.event",
        "tags": [
          "Machine",
          "Xray",
          "Xray1"
          "UK",
          "London",
          "West Hill",
          "Main Building",
          "First Floor",
          "Entrance"
        ],
        "tstamp": 1605716969769,
        "updateDate": "2020-10-17T16:29:29.769Z",
        "updaterId": "admin@microshare.io"
      }
  • data.event - this has 3 values:
  • “new” - the device has entered the range of the wave scanner
  • “remove” - the device was previously in range and has left the range of the wave scanner. RSSI will be 0
  • “confirm” - the device was previously in range and is still in range of the scanner
  • data.meta.device are the details of the detected asset
  • data.meta.source.device and .global are the details of the wave scanner that detected the device
  • data.movement - ( True – Asset is moving/False – Asset is not moving)
  • data.device.id - Tag ID (BLE Tag)
  • data.signal - Signal Strength
  • data.time - Event Time (Last Seen)

F. Heartbeat Data

Used in contact tracing and asset zoning solutions, a heartbeat record indicates a communication between Microshare and a wearable device to ensure that the device is operating properly. Heartbeat records are used for devices in storage mode and active devices with no previous contact records (which would otherwise not be detailed in the event data in contact tracing solutions).

Parameters:

  • id: The identification number of your device in communication.
  • deviceBattery: The battery level of your device.
  • messageType: This feild will be “contact” for a contact tracing solution and “asset” for a asset zoning solution.
  • mode: This field will read “storage” if the device in contact is in storage and inactive. If “nominal”, the device in contact is active but has no previous contact records.
{
  "device": {
    "id": "ACD340663???"
  },
  "deviceBattery": 2.673,
  "messageType": "contact",
  "meta": {
    "device": [],
    "iot": {
      "device_id": "ACD340663???"
    },
    "source": {
      "device": [
        "HQ",
        "Main Floor",
        "Break Room",
        ""
      ],
      "global": [],
      "iot": {
        "device_id": "AA-BB-CC-DD-00-??-??-??"
      },
      "source": {}
    }
  },
  "mode": "nominal",
  "time": "2020-10-05T17:19:02.855Z"
}

Did this doc help you?


For further questions or support, please contact us at support@microshare.io
ms logo