DeviceLocation_2 extends ComputedLocation
Contains the estimated position of the device within a circle based on the GPS data or the Sigfox Geolocation service
Table of Contents
- SOURCE_HD_NETWORK_LOCATION = 4
- computed using HD network location
- SOURCE_NETWORK_LOCATION = 2
- computed using Network location
- SOURCE_POI_LOCATION = 3
- computed using PoI location
- SOURCE_PRIVATE_DATABASE_LOCATION = 5
- computed using private database location
- SOURCE_PROXIMITY_LOCATION = 7
- computed using Proximity location
- SOURCE_RSSI_AND_POSITION_OF_THE_STATION = 0
- computed using RSSI and position of the station (legacy)
- SOURCE_THE_GPS_DATA_INSIDE_THE_PAYLOAD = 1
- computed using the GPS data inside the payload
- SOURCE_WIFI_LOCATION = 6
- computed using WiFi location
- $lat : float|null
- The device's estimated latitude
- $lng : float|null
- The device's estimated longitude
- $placeIds : array<string|int, mixed>|null
- The place ids computed by the Sigfox Geolocation service
- $radius : int|null
- The radius of the circle (meters)
- $source : int|null
- Define how the location has been computed:
- $time : int|null
- Timestamp of the message (in milliseconds since the Unix Epoch)
- $valid : bool|null
- true, if a valid estimation for this message is available (GPS or RSSI)
- from() : static
- Initializing a model from an array
- getLat() : float
- Getter for lat
- getLng() : float
- Getter for lng
- getPlaceIds() : array<string|int, string>
- Getter for placeIds
- getRadius() : int
- Getter for radius
- getSource() : int
- Getter for source
- getTime() : int
- Getter for time
- getValid() : bool
- Getter for valid
- jsonSerialize() : array<string|int, mixed>
- setLat() : static
- Setter for lat
- setLng() : static
- Setter for lng
- setPlaceIds() : static
- Setter for placeIds
- setRadius() : static
- Setter for radius
- setSource() : static
- Setter for source
- setTime() : static
- Setter for time
- setValid() : static
- Setter for valid
Constants
SOURCE_HD_NETWORK_LOCATION
computed using HD network location
public
mixed
SOURCE_HD_NETWORK_LOCATION
= 4
SOURCE_NETWORK_LOCATION
computed using Network location
public
mixed
SOURCE_NETWORK_LOCATION
= 2
SOURCE_POI_LOCATION
computed using PoI location
public
mixed
SOURCE_POI_LOCATION
= 3
SOURCE_PRIVATE_DATABASE_LOCATION
computed using private database location
public
mixed
SOURCE_PRIVATE_DATABASE_LOCATION
= 5
SOURCE_PROXIMITY_LOCATION
computed using Proximity location
public
mixed
SOURCE_PROXIMITY_LOCATION
= 7
SOURCE_RSSI_AND_POSITION_OF_THE_STATION
computed using RSSI and position of the station (legacy)
public
mixed
SOURCE_RSSI_AND_POSITION_OF_THE_STATION
= 0
SOURCE_THE_GPS_DATA_INSIDE_THE_PAYLOAD
computed using the GPS data inside the payload
public
mixed
SOURCE_THE_GPS_DATA_INSIDE_THE_PAYLOAD
= 1
SOURCE_WIFI_LOCATION
computed using WiFi location
public
mixed
SOURCE_WIFI_LOCATION
= 6
Properties
$lat
The device's estimated latitude
protected
float|null
$lat
= null
$lng
The device's estimated longitude
protected
float|null
$lng
= null
$placeIds
The place ids computed by the Sigfox Geolocation service
protected
array<string|int, mixed>|null
$placeIds
= null
$radius
The radius of the circle (meters)
protected
int|null
$radius
= null
$source
Define how the location has been computed:
protected
int|null
$source
= null
- ComputedLocation::SOURCE_RSSI_AND_POSITION_OF_THE_STATION
- ComputedLocation::SOURCE_THE_GPS_DATA_INSIDE_THE_PAYLOAD
- ComputedLocation::SOURCE_NETWORK_LOCATION
- ComputedLocation::SOURCE_POI_LOCATION
- ComputedLocation::SOURCE_HD_NETWORK_LOCATION
- ComputedLocation::SOURCE_PRIVATE_DATABASE_LOCATION
- ComputedLocation::SOURCE_WIFI_LOCATION
- ComputedLocation::SOURCE_PROXIMITY_LOCATION
$time
Timestamp of the message (in milliseconds since the Unix Epoch)
protected
int|null
$time
= null
$valid
true, if a valid estimation for this message is available (GPS or RSSI)
protected
bool|null
$valid
= null
Methods
from()
Initializing a model from an array
public
static from(array<string|int, mixed> $params) : static
Parameters
- $params : array<string|int, mixed>
-
Pass this parameter if you want to initial property value from an array. See API reference for all property names and types
Tags
Return values
static —getLat()
Getter for lat
public
getLat() : float
Return values
float —The device's estimated latitude
getLng()
Getter for lng
public
getLng() : float
Return values
float —The device's estimated longitude
getPlaceIds()
Getter for placeIds
public
getPlaceIds() : array<string|int, string>
Return values
array<string|int, string> —The place ids computed by the Sigfox Geolocation service
getRadius()
Getter for radius
public
getRadius() : int
Return values
int —The radius of the circle (meters)
getSource()
Getter for source
public
getSource() : int
Return values
int —Define how the location has been computed:
- ComputedLocation::SOURCE_RSSI_AND_POSITION_OF_THE_STATION
- ComputedLocation::SOURCE_THE_GPS_DATA_INSIDE_THE_PAYLOAD
- ComputedLocation::SOURCE_NETWORK_LOCATION
- ComputedLocation::SOURCE_POI_LOCATION
- ComputedLocation::SOURCE_HD_NETWORK_LOCATION
- ComputedLocation::SOURCE_PRIVATE_DATABASE_LOCATION
- ComputedLocation::SOURCE_WIFI_LOCATION
- ComputedLocation::SOURCE_PROXIMITY_LOCATION
getTime()
Getter for time
public
getTime() : int
Return values
int —Timestamp of the message (in milliseconds since the Unix Epoch)
getValid()
Getter for valid
public
getValid() : bool
Return values
bool —true, if a valid estimation for this message is available (GPS or RSSI)
jsonSerialize()
public
jsonSerialize() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —setLat()
Setter for lat
public
setLat(float $lat) : static
Parameters
- $lat : float
-
The device's estimated latitude
Return values
static —To use in method chains
setLng()
Setter for lng
public
setLng(float $lng) : static
Parameters
- $lng : float
-
The device's estimated longitude
Return values
static —To use in method chains
setPlaceIds()
Setter for placeIds
public
setPlaceIds(array<string|int, string> $placeIds) : static
Parameters
- $placeIds : array<string|int, string>
-
The place ids computed by the Sigfox Geolocation service
Return values
static —To use in method chains
setRadius()
Setter for radius
public
setRadius(int $radius) : static
Parameters
- $radius : int
-
The radius of the circle (meters)
Return values
static —To use in method chains
setSource()
Setter for source
public
setSource(int $source) : static
Parameters
- $source : int
-
Define how the location has been computed:
- ComputedLocation::SOURCE_RSSI_AND_POSITION_OF_THE_STATION
- ComputedLocation::SOURCE_THE_GPS_DATA_INSIDE_THE_PAYLOAD
- ComputedLocation::SOURCE_NETWORK_LOCATION
- ComputedLocation::SOURCE_POI_LOCATION
- ComputedLocation::SOURCE_HD_NETWORK_LOCATION
- ComputedLocation::SOURCE_PRIVATE_DATABASE_LOCATION
- ComputedLocation::SOURCE_WIFI_LOCATION
- ComputedLocation::SOURCE_PROXIMITY_LOCATION
Return values
static —To use in method chains
setTime()
Setter for time
public
setTime(int $time) : static
Parameters
- $time : int
-
Timestamp of the message (in milliseconds since the Unix Epoch)
Return values
static —To use in method chains
setValid()
Setter for valid
public
setValid(bool $valid) : static
Parameters
- $valid : bool
-
true, if a valid estimation for this message is available (GPS or RSSI)
Return values
static —To use in method chains