Guides Reference Samples Support

Collection: beacons.diagnostics

Resource: Diagnostics

Diagnostics for a single beacon.

JSON representation 
{
  "beaconName": string,
  "estimatedLowBatteryDate": {
    object(Date)
  },
  "alerts": [
    enum(Alert)
  ],
}
Fields
beaconName

string

Resource name of the beacon. For Eddystone-EID beacons, this may be the beacon's current EID, or the beacon's "stable" Eddystone-UID.

estimatedLowBatteryDate

object(Date)

The date when the battery is expected to be low. If the value is missing then there is no estimate for when the battery will be low. This value is only an estimate, not an exact date.

alerts[]

enum(Alert)

An unordered list of Alerts that the beacon has.

Date

Represents a whole calendar date, e.g. date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. The day may be 0 to represent a year and month where the day is not significant, e.g. credit card expiration date. The year may be 0 to represent a month and day independent of year, e.g. anniversary date. Related types are google.type.TimeOfDay and google.protobuf.Timestamp.

JSON representation 
{
  "year": number,
  "month": number,
  "day": number,
}
Fields
year

number

Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.

month

number

Month of year. Must be from 1 to 12.

day

number

Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year/month where the day is not significant.

Alert

Types of alerts, or problems that require more investigation, that beacons can have.

Enums
ALERT_UNSPECIFIED Invalid value. Should never appear.
WRONG_LOCATION The beacon has been reported far from its expected location (the beacon's latLng field if populated, otherwise, if the beacon's placeId field is present, the center of that place). This may indicate that the beacon has been moved. This signal is not 100% accurate, but indicates that further investigation is worthwhile.
LOW_BATTERY The battery level for the beacon is low enough that, given the beacon's current use, its battery will run out with in the next 60 days. This indicates that the battery should be replaced soon.
LOW_ACTIVITY The beacon has been reported at a very low rate or not at all. This may indicate that the beacon is broken or just that no one has gone near the beacon in recent days. If this status appears unexpectedly, the beacon owner should investigate further.

Methods

list

 List the diagnostics for a single beacon.