Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Introduction

Bluzone exposes a REST API that exposes the current location of the Beacon.  Bluzone Location Engine will render a new Beacon location at a period defined in your Project's RTLS Settings.  The location response will include a Latitude and Longitude value.  If your RTLS Engine Algorithm is set to "Best Blufi", then the LAT/LON values returned are the same as the Blufi identified as "Best Blufi".

Example

...

MethodGET
URLhttps://bluzone.io/portal/papis/v1/search/locations/map/
11478/6866530409575632130
{{projectId}}/{{beacon.deviceId}}
Response Content-Typeapplication/json
Headerbzid

...

languagebash
titleGet Beacon Location


Sample Response

Code Block
languagejs
titleLocation Response
{
    "BLUZONE": {
        "altitude": 194.15300031378865,
        "beaconId": "{{beacon.deviceId}}",
        "blufiPeriodStats": [
            {
                "blufiId": "REDACTED_BLUFI_DEVICE_ID",
                "meterToLocation": null,
                "name": "Blufi Behind Mikes Desk",
                "rssiAverage": -71.61700820922852,
                "rssiCount": 2,
                "sid64": "4061058898803384480",
                "blufiInsertMillis": 1550690229044,
                "rssiHistorical": null,
                "minTimestamp": 25703544832,
                "maxTimestamp": 25703545839,
                "enhanceDropped": null,
                "globalThresholdViolated": null,
                "minimumSampleCountViolated": null,
                "remainingInBucket": null,
                "newInBucket": 2,
                "behindTrigger": -25703545839,
                "averageLatencyMillis": null,
                "maxLatencyMillis": null
            },
            {
                "blufiId": "REDACTED_BLUFI_DEVICE_ID",
                "meterToLocation": null,
                "name": "Blufi Rick's Desk area",
                "rssiAverage": -72.7808952331543,
                "rssiCount": 2,
                "sid64": "600881077478007212",
                "blufiInsertMillis": 1550690229044,
                "rssiHistorical": null,
                "minTimestamp": 25703544832,
                "maxTimestamp": 25703545839,
                "enhanceDropped": null,
                "globalThresholdViolated": null,
                "minimumSampleCountViolated": null,
                "remainingInBucket": null,
                "newInBucket": 2,
                "behindTrigger": -25703545839,
                "averageLatencyMillis": null,
                "maxLatencyMillis": null
            },
            {
                "blufiId": "REDACTED_BLUFI_DEVICE_ID",
                "meterToLocation": null,
                "name": "Training room back outside wall",
                "rssiAverage": -77.3737907409668,
                "rssiCount": 2,
                "sid64": "12507011242568423825",
                "blufiInsertMillis": 1550690229044,
                "rssiHistorical": null,
                "minTimestamp": 25703544832,
                "maxTimestamp": 25703545839,
                "enhanceDropped": null,
                "globalThresholdViolated": null,
                "minimumSampleCountViolated": null,
                "remainingInBucket": null,
                "newInBucket": 2,
                "behindTrigger": -25703545839,
                "averageLatencyMillis": null,
                "maxLatencyMillis": null
            }
        ],
        "boundaryCorrected": null,
        "boundaryExclusionCorrected": null,
        "deviceName": "Beacon - John Doe",
        "direction": null,
        "displayRadius": 1.5767331526708015,
        "error": "OK",
        "errorDescription": null,
        "fingerprintEstimate": null,
        "fingerprintLocations": [],
        "floorNumber": 1,
        "generatorType": "BLUZONE",
        "geoJsonMap": null,
        "intersectionGroup": [],
        "latitude": 32.95644162009803,
        "longitude": -96.70910070111486,
        "mac": "01:e7:d6:70:b1:83:48",
        "meterChangeEstimate": 0.49330667230736464,
        "motionStatic": null,
        "projectId": REDACTED_PROJECT_ID,
        "thresholdCorrected": null,
        "timestamp": 1550690182364,
        "type": "location",
        "varianceX": 1.1049277487694245,
        "varianceY": 1.0627229400558122,
        "varianceZ": null,
        "windowCalculationRange": 4000,
        "locationId": REDACTED_LOCATION_ID,
        "cellId": -8769600164440266311,
        "battery": null,
        "gt": null,
        "jobModeBlufis": [],
        "averageSourceDelayMillis": 5987,
        "sunstoneDelayMillis": 2815,
        "windowCount": 26,
        "maxTimestamp": 1550690227150
    }
}

...