PAWS: init

Initializes the connection between a white space device and the database.

The initialization routine is not required by the Google Spectrum Database, but can be invoked by the client device. It is recommended that devices only invoke the spectrum.paws.getSpectrum method.

Request

HTTP request

POST https://www.googleapis.com/rpc

Request body

In the request body, supply data with the following structure:

{
  "jsonrpc": "2.0",
  "method": "spectrum.paws.init",
  "apiVersion": "v1explorer",
  "id": string,
  "params": {
    "key": api key,
    "type": "INIT_REQ",
    "version": "1.0",
    "deviceDesc": {
      "serialNumber": string,
      "manufacturerId": string,
      "modelId": string,
      "rulesetIds": [
        string
      ],
      "fccId": string,
      "fccTvbdDeviceType": string,
      "etsiEnDeviceType": string,
      "etsiEnDeviceEmissionsClass": string,
      "etsiEnTechnologyId": string,
      "etsiEnDeviceCategory": string
    },
    "location": {
      "point": {
        "center": {
          "latitude": double,
          "longitude": double
        },
        "semiMajorAxis": double,
        "semiMinorAxis": double,
        "orientation": double
      },
      "region": {
        "exterior": [
          {
           "latitude": double,
           "longitude": double
          }
        ]
      },
      "confidence": integer
    }
  }
}
Property name Value Description Notes
type string The message type: INIT_REQ.

Required field
version string The PAWS version. Must be exactly 1.0.

Required field.
deviceDesc nested object The DeviceDescriptor parameter is required. If the database does not support the device or any of the rulesets specified in the device descriptor, it must return an UNSUPPORTED error code in the error response.
deviceDesc.serialNumber string The manufacturer's device serial number; required by the applicable regulatory domain. The length of the value must not exceed 64 characters.
deviceDesc.manufacturerId string The manufacturer's ID may be required by the regulatory domain. This should represent the name of the device manufacturer, should be consistent across all devices from the same manufacturer, and should be distinct from that of other manufacturers. The string value must not exceed 64 characters in length.
deviceDesc.modelId string The device's model ID may be required by the regulatory domain. The string value must not exceed 64 characters in length.
deviceDesc.rulesetIds[] list The list of identifiers for rulesets supported by the device. A database may require that the device provide this list before servicing the device requests. If the database does not support any of the rulesets specified in the list, the database may refuse to service the device requests. If present, the list must contain at least one entry.

For information about the valid requests, see section 9.2 of the PAWS specification. Currently, FccTvBandWhiteSpace-2010 is the only supported ruleset.
deviceDesc.fccId string Specifies the device's FCC certification identifier. The value is an identifier string whose length should not exceed 32 characters. Note that, in practice, a valid FCC ID may be limited to 19 characters.
deviceDesc.fccTvbdDeviceType string Specifies the TV Band White Space device type, as defined by the FCC. Valid values are FIXED, MODE_1, MODE_2.
deviceDesc.etsiEnDeviceType string Specifies the ETSI white space device type. Valid values are single-letter strings, such as A, B, etc. Consult the ETSI documentation for details about the device types.
deviceDesc.etsiEnDeviceEmissionsClass string Specifies the ETSI white space device emissions class. The values are represented by numeric strings, such as 1, 2, etc. Consult the ETSI documentation for details about the device types.
deviceDesc.etsiEnTechnologyId string Specifies the ETSI white space device technology identifier. The string value must not exceed 64 characters in length. Consult the ETSI documentation for details about the device types.
deviceDesc.etsiEnDeviceCategory string Specifies the ETSI white space device category. Valid values are the strings master and slave. This field is case-insensitive. Consult the ETSI documentation for details about the device types.
location nested object A device's geolocation is required.
location.point nested object If present, indicates that the geolocation represents a point. Paradoxically, a point is parameterized using an ellipse, where the center represents the location of the point and the distances along the major and minor axes represent the uncertainty. The uncertainty values may be required, depending on the regulatory domain.
location.point.center nested object A required geo-spatial point representing the center of the ellipse.
location.point.center.latitude double A required floating-point number that expresses the latitude in degrees using the WGS84 datum. For details on this encoding, see the National Imagery and Mapping Agency's Technical Report TR8350.2.
location.point.center.longitude double A required floating-point number that expresses the longitude in degrees using the WGS84 datum. For details on this encoding, see the National Imagery and Mapping Agency's Technical Report TR8350.2.
location.point.semiMajorAxis double A floating-point number that expresses the location uncertainty along the major axis of the ellipse. May be required by the regulatory domain. When the uncertainty is optional, the default value is 0.
location.point.semiMinorAxis double A floating-point number that expresses the location uncertainty along the minor axis of the ellipse. May be required by the regulatory domain. When the uncertainty is optional, the default value is 0.
location.point.orientation double A floating-point number that expresses the orientation of the ellipse, representing the rotation, in degrees, of the semi-major axis from North towards the East. For example, when the uncertainty is greatest along the North-South direction, orientation is 0 degrees; conversely, if the uncertainty is greatest along the East-West direction, orientation is 90 degrees. When orientation is not present, the orientation is assumed to be 0.
location.region nested object If present, indicates that the geolocation represents a region. Database support for regions is optional.
location.region.exterior[] list When the geolocation describes a region, the exterior field refers to a list of latitude/longitude points that represent the vertices of a polygon. The first and last points must be the same. Thus, a minimum of four points is required. The following polygon restrictions from RFC5491 apply:
  • A connecting line shall not cross another connecting line of the same polygon.
  • The vertices must be defined in a counterclockwise order.
  • The edges of a polygon are defined by the shortest path between two points in space (not a geodesic curve). Consequently, the length between two adjacent vertices should be restricted to a maximum of 130 km.
  • All vertices are assumed to be at the same altitude.
  • Polygon shapes should be restricted to a maximum of 15 vertices (16 points that include the repeated vertex).
location.region.exterior[].latitude double A required floating-point number that expresses the latitude in degrees using the WGS84 datum. For details on this encoding, see the National Imagery and Mapping Agency's Technical Report TR8350.2.
location.region.exterior[].longitude double A required floating-point number that expresses the longitude in degrees using the WGS84 datum. For details on this encoding, see the National Imagery and Mapping Agency's Technical Report TR8350.2.
location.confidence integer The location confidence level, as an integer percentage, may be required, depending on the regulatory domain. When the parameter is optional and not provided, its value is assumed to be 95. Valid values range from 0 to 99, since, in practice, 100-percent confidence is not achievable. The confidence value is meaningful only when geolocation refers to a point with uncertainty.

Response

If successful, this method returns a response body with the following structure:

{
  "jsonrpc": "2.0",
  "id": string,
  "result": {
    "type": "INIT_RESP",
    "version": "1.0",
    "rulesetInfo": {
      "authority": string,
      "maxLocationChange": double,
      "maxPollingSecs": integer,
      "rulesetIds": [
        string
      ]
    },
    "databaseChange": {
      "databases": [
        {
          "name": string,
          "uri": string
        }
      ]
    }
  }
}
Property name Value Description Notes
type string The message type: INIT_RESP.

Required field
version string The PAWS version. Must be exactly 1.0.

Required field.
rulesetInfo nested object The rulesetInfo parameter must be included in the response. This parameter specifies the regulatory domain and parameters applicable to that domain. The database must include the authority field, which defines the regulatory domain for the location specified in the INIT_REQ message.
rulesetInfo.authority string The regulatory domain to which the ruleset belongs is required. It must be a 2-letter country code. The device should use this to determine additional device behavior required by the associated regulatory domain.
rulesetInfo.maxLocationChange double The maximum location change in meters is required in the initialization response, but optional otherwise. When the device changes location by more than this specified distance, it must contact the database to get the available spectrum for the new location. If the device is using spectrum that is no longer available, it must immediately cease use of the spectrum under rules for database-managed spectrum. If this value is provided within the context of an available-spectrum response, it takes precedence over the value within the initialization response.
rulesetInfo.maxPollingSecs integer The maximum duration, in seconds, between requests for available spectrum. It is required in the initialization response, but optional otherwise. The device must contact the database to get available spectrum no less frequently than this duration. If the new spectrum information indicates that the device is using spectrum that is no longer available, it must immediately cease use of those frequencies under rules for database-managed spectrum. If this value is provided within the context of an available-spectrum response, it takes precedence over the value within the initialization response.
rulesetInfo.rulesetIds[] list The identifiers of the rulesets supported for the device's location. The database should include at least one applicable ruleset in the initialization response. The device may use the ruleset identifiers to determine parameters to include in subsequent requests. Within the context of the available-spectrum responses, the database should include the identifier of the ruleset that it used to determine the available-spectrum response. If included, the device must use the specified ruleset to interpret the response. If the device does not support the indicated ruleset, it must not operate in the spectrum governed by the ruleset.
databaseChange nested object A database may include the databaseChange parameter to notify a device of a change to its database URI, providing one or more alternate database URIs. The device should use this information to update its list of pre-configured databases by (only) replacing its entry for the responding database with the list of alternate URIs.
databaseChange.databases[] list A required list of one or more databases. A device should update its preconfigured list of databases to replace (only) the database that provided the response with the specified entries.
databaseChange.databases[].name string The display name for a database.
databaseChange.databases[].uri string The corresponding URI of the database.