google_api_spectrum v0.1.0 API Reference

Modules

API calls for all endpoints tagged Paws

Handle Tesla connections for GoogleApi.Spectrum.V1explorer

Helper functions for deserializing responses into models

Antenna characteristics provide additional information, such as the antenna height, antenna type, etc. Whether antenna characteristics must be provided in a request depends on the device type and regulatory domain

This message contains the name and URI of a database

This message is provided by the database to notify devices of an upcoming change to the database URI

Device capabilities provide additional information that may be used by a device to provide additional information to the database that may help it to determine available spectrum. If the database does not support device capabilities it will ignore the parameter altogether

The device descriptor contains parameters that identify the specific device, such as its manufacturer serial number, regulatory-specific identifier (e.g., FCC ID), and any other device characteristics required by regulatory domains

This parameter contains device-owner information required as part of device registration. The regulatory domains may require additional parameters. All contact information must be expressed using the structure defined by the vCard format specification. Only the contact fields of vCard are supported: - fn: Full name of an individual - org: Name of the organization - adr: Address fields - tel: Telephone numbers - email: Email addresses Note that the vCard specification defines maximum lengths for each field

The device validity element describes whether a particular device is valid to operate in the regulatory domain

The start and stop times of an event. This is used to indicate the time period for which a spectrum profile is valid. Both times are expressed using the format, YYYY-MM-DDThh:mm:ssZ, as defined in RFC3339. The times must be expressed using UTC

A specific range of frequencies together with the associated maximum power level and channel identifier

This parameter is used to specify the geolocation of the device

A "point" with uncertainty is represented using the Ellipse shape

A single geolocation on the globe

A region is represented using the polygonal shape

The schedule of spectrum profiles available at a particular geolocation

The request message for a batch available spectrum query protocol

The response message for the batch available spectrum query contains a schedule of available spectrum for the device at multiple locations

The request message for the available spectrum query protocol which must include the device's geolocation

The response message for the available spectrum query which contains a schedule of available spectrum for the device

The initialization request message allows the master device to initiate exchange of capabilities with the database

The initialization response message communicates database parameters to the requesting device

The spectrum-use notification message which must contain the geolocation of the Device and parameters required by the regulatory domain

The registration request message contains the required registration parameters

The registration response message simply acknowledges receipt of the request and is otherwise empty

The device validation request message

The device validation response message

This contains parameters for the ruleset of a regulatory domain that is communicated using the initialization and available-spectrum processes

Available spectrum can be logically characterized by a list of frequency ranges and permissible power levels for each range

The spectrum schedule element combines an event time with spectrum profile to define a time period in which the profile is valid

A vCard-in-JSON message that contains only the fields needed for PAWS: - fn: Full name of an individual - org: Name of the organization - adr: Address fields - tel: Telephone numbers - email: Email addresses

The structure used to represent a street address

The structure used to represent a telephone number

The structure used to represent an organization and an email address

Helper functions for building Tesla requests