PHP Sigfox Client

SiteCreation extends SiteUpdate

Generic information about a site

Table of Contents

INVERTER_INFO_AC_POWER_HOST  = 1
AC POWER HOST
INVERTER_INFO_AC_POWER_HOST_INVERTER  = 2
AC POWER HOST INVERTER
INVERTER_INFO_AC_POWER_SIGFOX_INVERTER  = 3
AC POWER SIGFOX INVERTER
INVERTER_INFO_DC_POWER_HOST_48V  = 4
DC POWER HOST 48V
INVERTER_INFO_DC_POWER_SOLAR  = 5
DC POWER SOLAR
INVERTER_INFO_NONE  = 0
NONE
STATION_INSTALLATION_INDOOR_WITH_CABINET  = 2
INDOOR WITH CABINET
STATION_INSTALLATION_INDOOR_WITHOUT_CABINET  = 0
INDOOR WITHOUT CABINET
STATION_INSTALLATION_OUTDOOR_WITH_CABINET  = 1
OUTDOOR WITH CABINET
STATION_INSTALLATION_OUTDOOR_WITHOUT_CABINET  = 3
OUTDOOR WITHOUT CABINET
STATUS_CANCELLED  = 6
CANCELLED
STATUS_CANDIDATE  = 5
CANDIDATE
STATUS_CLIENT  = 7
CLIENT
STATUS_INSTALLED  = 2
INSTALLED
STATUS_INSTALLED_CONNECTED_ONLY_PRIMARY  = 15
INSTALLED CONNECTED ONLY PRIMARY
STATUS_INSTALLED_CONNECTED_ONLY_SECONDARY  = 14
INSTALLED CONNECTED ONLY SECONDARY
STATUS_LABO  = 9
LABO
STATUS_NOT_PLANNED  = 3
NOT PLANNED
STATUS_PRE_PROD  = 4
PRE PROD
STATUS_PROD  = 0
PROD
STATUS_RD  = 8
RD
STATUS_REFUSED  = 1
REFUSED
$address  : string|null
The address of the site
$aerialWorkPlatformAccess  : bool|null
is the site access to the aerial work platform
$comment  : string|null
Comment about the site. This field can be unset when updating.
$groupId  : string|null
identifier of the group of this site
$inverterInfo  : int|null
Inverter type:
$lat  : float|null
the site's latitude
$lessorId  : string|null
The lessor identifier of the site. This field can be unset when updating.
$lng  : float|null
the site's longitutde
$location  : array<string|int, mixed>|null
ISO 3166-1 UN M.49 country code of the site location.
$name  : string|null
The site's name
$stationInstallation  : int|null
Station installation:
$status  : int|null
Site status:
$statusComment  : string|null
The comment of the status of the site. This field can be unset when updating.
from()  : static
Initializing a model from an array
getAddress()  : string
Getter for address
getAerialWorkPlatformAccess()  : bool
Getter for aerialWorkPlatformAccess
getComment()  : string
Getter for comment
getGroupId()  : string
Getter for groupId
getInverterInfo()  : int
Getter for inverterInfo
getLat()  : float
Getter for lat
getLessorId()  : string
Getter for lessorId
getLng()  : float
Getter for lng
getLocation()  : array<string|int, int>
Getter for location
getName()  : string
Getter for name
getStationInstallation()  : int
Getter for stationInstallation
getStatus()  : int
Getter for status
getStatusComment()  : string
Getter for statusComment
jsonSerialize()  : array<string|int, mixed>
setAddress()  : static
Setter for address
setAerialWorkPlatformAccess()  : static
Setter for aerialWorkPlatformAccess
setComment()  : static
Setter for comment
setGroupId()  : static
Setter for groupId
setInverterInfo()  : static
Setter for inverterInfo
setLat()  : static
Setter for lat
setLessorId()  : static
Setter for lessorId
setLng()  : static
Setter for lng
setLocation()  : static
Setter for location
setName()  : static
Setter for name
setStationInstallation()  : static
Setter for stationInstallation
setStatus()  : static
Setter for status
setStatusComment()  : static
Setter for statusComment

Constants

INVERTER_INFO_AC_POWER_HOST

AC POWER HOST

public mixed INVERTER_INFO_AC_POWER_HOST = 1

INVERTER_INFO_AC_POWER_HOST_INVERTER

AC POWER HOST INVERTER

public mixed INVERTER_INFO_AC_POWER_HOST_INVERTER = 2

INVERTER_INFO_AC_POWER_SIGFOX_INVERTER

AC POWER SIGFOX INVERTER

public mixed INVERTER_INFO_AC_POWER_SIGFOX_INVERTER = 3

INVERTER_INFO_DC_POWER_HOST_48V

DC POWER HOST 48V

public mixed INVERTER_INFO_DC_POWER_HOST_48V = 4

INVERTER_INFO_DC_POWER_SOLAR

DC POWER SOLAR

public mixed INVERTER_INFO_DC_POWER_SOLAR = 5

INVERTER_INFO_NONE

NONE

public mixed INVERTER_INFO_NONE = 0

STATION_INSTALLATION_INDOOR_WITH_CABINET

INDOOR WITH CABINET

public mixed STATION_INSTALLATION_INDOOR_WITH_CABINET = 2

STATION_INSTALLATION_INDOOR_WITHOUT_CABINET

INDOOR WITHOUT CABINET

public mixed STATION_INSTALLATION_INDOOR_WITHOUT_CABINET = 0

STATION_INSTALLATION_OUTDOOR_WITH_CABINET

OUTDOOR WITH CABINET

public mixed STATION_INSTALLATION_OUTDOOR_WITH_CABINET = 1

STATION_INSTALLATION_OUTDOOR_WITHOUT_CABINET

OUTDOOR WITHOUT CABINET

public mixed STATION_INSTALLATION_OUTDOOR_WITHOUT_CABINET = 3

STATUS_CANCELLED

CANCELLED

public mixed STATUS_CANCELLED = 6

STATUS_CANDIDATE

CANDIDATE

public mixed STATUS_CANDIDATE = 5

STATUS_CLIENT

CLIENT

public mixed STATUS_CLIENT = 7

STATUS_INSTALLED

INSTALLED

public mixed STATUS_INSTALLED = 2

STATUS_INSTALLED_CONNECTED_ONLY_PRIMARY

INSTALLED CONNECTED ONLY PRIMARY

public mixed STATUS_INSTALLED_CONNECTED_ONLY_PRIMARY = 15

STATUS_INSTALLED_CONNECTED_ONLY_SECONDARY

INSTALLED CONNECTED ONLY SECONDARY

public mixed STATUS_INSTALLED_CONNECTED_ONLY_SECONDARY = 14

STATUS_LABO

LABO

public mixed STATUS_LABO = 9

STATUS_NOT_PLANNED

NOT PLANNED

public mixed STATUS_NOT_PLANNED = 3

STATUS_PRE_PROD

PRE PROD

public mixed STATUS_PRE_PROD = 4

STATUS_PROD

PROD

public mixed STATUS_PROD = 0

STATUS_REFUSED

REFUSED

public mixed STATUS_REFUSED = 1

Properties

$address

The address of the site

protected string|null $address = null

$aerialWorkPlatformAccess

is the site access to the aerial work platform

protected bool|null $aerialWorkPlatformAccess = null

$comment

Comment about the site. This field can be unset when updating.

protected string|null $comment = null

$groupId

identifier of the group of this site

protected string|null $groupId = null

$lat

the site's latitude

protected float|null $lat = null

$lessorId

The lessor identifier of the site. This field can be unset when updating.

protected string|null $lessorId = null

$lng

the site's longitutde

protected float|null $lng = null

$location

ISO 3166-1 UN M.49 country code of the site location.

protected array<string|int, mixed>|null $location = null

The first code is the country (region and department available for some countries).

$name

The site's name

protected string|null $name = null

$statusComment

The comment of the status of the site. This field can be unset when updating.

protected string|null $statusComment = 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
throws
DeserializeException

If provided an invalid type to a property

Return values
static —

getAddress()

Getter for address

public getAddress() : string
Return values
string —

The address of the site

getAerialWorkPlatformAccess()

Getter for aerialWorkPlatformAccess

public getAerialWorkPlatformAccess() : bool
Return values
bool —

is the site access to the aerial work platform

getComment()

Getter for comment

public getComment() : string
Return values
string —

Comment about the site. This field can be unset when updating.

getGroupId()

Getter for groupId

public getGroupId() : string
Return values
string —

identifier of the group of this site

getLat()

Getter for lat

public getLat() : float
Return values
float —

the site's latitude

getLessorId()

Getter for lessorId

public getLessorId() : string
Return values
string —

The lessor identifier of the site. This field can be unset when updating.

getLng()

Getter for lng

public getLng() : float
Return values
float —

the site's longitutde

getLocation()

Getter for location

public getLocation() : array<string|int, int>
Return values
array<string|int, int> —

ISO 3166-1 UN M.49 country code of the site location. The first code is the country (region and department available for some countries).

getName()

Getter for name

public getName() : string
Return values
string —

The site's name

getStatusComment()

Getter for statusComment

public getStatusComment() : string
Return values
string —

The comment of the status of the site. This field can be unset when updating.

jsonSerialize()

public jsonSerialize() : array<string|int, mixed>
Tags
inheritdoc
Return values
array<string|int, mixed> —

setAddress()

Setter for address

public setAddress(string $address) : static
Parameters
$address : string

The address of the site

Return values
static —

To use in method chains

setAerialWorkPlatformAccess()

Setter for aerialWorkPlatformAccess

public setAerialWorkPlatformAccess(bool $aerialWorkPlatformAccess) : static
Parameters
$aerialWorkPlatformAccess : bool

is the site access to the aerial work platform

Return values
static —

To use in method chains

setComment()

Setter for comment

public setComment(string $comment) : static
Parameters
$comment : string

Comment about the site. This field can be unset when updating.

Return values
static —

To use in method chains

setGroupId()

Setter for groupId

public setGroupId(string $groupId) : static
Parameters
$groupId : string

identifier of the group of this site

Return values
static —

To use in method chains

setLat()

Setter for lat

public setLat(float $lat) : static
Parameters
$lat : float

the site's latitude

Return values
static —

To use in method chains

setLessorId()

Setter for lessorId

public setLessorId(string $lessorId) : static
Parameters
$lessorId : string

The lessor identifier of the site. This field can be unset when updating.

Return values
static —

To use in method chains

setLng()

Setter for lng

public setLng(float $lng) : static
Parameters
$lng : float

the site's longitutde

Return values
static —

To use in method chains

setLocation()

Setter for location

public setLocation(array<string|int, int> $location) : static
Parameters
$location : array<string|int, int>

ISO 3166-1 UN M.49 country code of the site location. The first code is the country (region and department available for some countries).

Return values
static —

To use in method chains

setName()

Setter for name

public setName(string $name) : static
Parameters
$name : string

The site's name

Return values
static —

To use in method chains

setStatus()

Setter for status

public setStatus(int $status) : static
Parameters
$status : int

Site status:

Return values
static —

To use in method chains

setStatusComment()

Setter for statusComment

public setStatusComment(string $statusComment) : static
Parameters
$statusComment : string

The comment of the status of the site. This field can be unset when updating.

Return values
static —

To use in method chains

Search results