gogol-spectrum-0.0.1: Google Spectrum Database SDK.

Copyright(c) 2015 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.Google.Spectrum.Types

Contents

Description

 

Synopsis

Service Configuration

spectrumService :: Service Source

Default request referring to version v1explorer of the Google Spectrum Database API. This contains the host and root path used as a starting point for constructing service requests.

GeoLocationPolygon

data GeoLocationPolygon Source

A region is represented using the polygonal shape.

See: geoLocationPolygon smart constructor.

Instances

geoLocationPolygon :: GeoLocationPolygon Source

Creates a value of GeoLocationPolygon with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

glpExterior :: Lens' GeoLocationPolygon [GeoLocationPoint] Source

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).

GeoLocationPoint

data GeoLocationPoint Source

A single geolocation on the globe.

See: geoLocationPoint smart constructor.

Instances

geoLocationPoint :: GeoLocationPoint Source

Creates a value of GeoLocationPoint with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

glpLatitude :: Lens' GeoLocationPoint (Maybe Double) Source

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.

glpLongitude :: Lens' GeoLocationPoint (Maybe Double) Source

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.

PawsInitResponse

data PawsInitResponse Source

The initialization response message communicates database parameters to the requesting device.

See: pawsInitResponse smart constructor.

Instances

pawsInitResponse :: PawsInitResponse Source

Creates a value of PawsInitResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

pirKind :: Lens' PawsInitResponse Text Source

Identifies what kind of resource this is. Value: the fixed string "spectrum#pawsInitResponse".

pirVersion :: Lens' PawsInitResponse (Maybe Text) Source

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

pirRulesetInfo :: Lens' PawsInitResponse (Maybe RulesetInfo) Source

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.

pirType :: Lens' PawsInitResponse (Maybe Text) Source

The message type (e.g., INIT_REQ, AVAIL_SPECTRUM_REQ, ...). Required field.

pirDatabaseChange :: Lens' PawsInitResponse (Maybe DBUpdateSpec) Source

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.

PawsRegisterResponse

data PawsRegisterResponse Source

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

See: pawsRegisterResponse smart constructor.

Instances

pawsRegisterResponse :: PawsRegisterResponse Source

Creates a value of PawsRegisterResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

prrKind :: Lens' PawsRegisterResponse Text Source

Identifies what kind of resource this is. Value: the fixed string "spectrum#pawsRegisterResponse".

prrVersion :: Lens' PawsRegisterResponse (Maybe Text) Source

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

prrType :: Lens' PawsRegisterResponse (Maybe Text) Source

The message type (e.g., INIT_REQ, AVAIL_SPECTRUM_REQ, ...). Required field.

prrDatabaseChange :: Lens' PawsRegisterResponse (Maybe DBUpdateSpec) Source

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.

PawsNotifySpectrumUseRequest

data PawsNotifySpectrumUseRequest Source

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

See: pawsNotifySpectrumUseRequest smart constructor.

Instances

pawsNotifySpectrumUseRequest :: PawsNotifySpectrumUseRequest Source

Creates a value of PawsNotifySpectrumUseRequest with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

pnsurSpectra :: Lens' PawsNotifySpectrumUseRequest [SpectrumMessage] Source

A spectrum list is required in the spectrum-use notification. The list specifies the spectrum that the device expects to use, which includes frequency ranges and maximum power levels. The list may be empty if the device decides not to use any of spectrum. For consistency, the psdBandwidthHz value should match that from one of the spectrum elements in the corresponding available spectrum response previously sent to the device by the database. Note that maximum power levels in the spectrum element must be expressed as power spectral density over the specified psdBandwidthHz value. The actual bandwidth to be used (as computed from the start and stop frequencies) may be different from the psdBandwidthHz value. As an example, when regulatory rules express maximum power spectral density in terms of maximum power over any 100 kHz band, then the psdBandwidthHz value should be set to 100 kHz, even though the actual bandwidth used can be 20 kHz.

pnsurLocation :: Lens' PawsNotifySpectrumUseRequest (Maybe GeoLocation) Source

The geolocation of the master device (the device that is sending the spectrum-use notification) to the database is required in the spectrum-use notification message.

pnsurVersion :: Lens' PawsNotifySpectrumUseRequest (Maybe Text) Source

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

pnsurType :: Lens' PawsNotifySpectrumUseRequest (Maybe Text) Source

The message type (e.g., INIT_REQ, AVAIL_SPECTRUM_REQ, ...). Required field.

pnsurDeviceDesc :: Lens' PawsNotifySpectrumUseRequest (Maybe DeviceDescriptor) Source

Device descriptor information is required in the spectrum-use notification message.

Vcard

data Vcard Source

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

See: vcard smart constructor.

Instances

vcard :: Vcard Source

Creates a value of Vcard with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

vEmail :: Lens' Vcard (Maybe VcardTypedText) Source

An email address that can be used to reach the contact.

vAdr :: Lens' Vcard (Maybe VcardAddress) Source

The street address of the entity.

vOrg :: Lens' Vcard (Maybe VcardTypedText) Source

The organization associated with the registering entity.

vTel :: Lens' Vcard (Maybe VcardTelephone) Source

A telephone number that can be used to call the contact.

vFn :: Lens' Vcard (Maybe Text) Source

The full name of the contact person. For example: John A. Smith.

DBUpdateSpec

data DBUpdateSpec Source

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

See: dbUpdateSpec smart constructor.

Instances

dbUpdateSpec :: DBUpdateSpec Source

Creates a value of DBUpdateSpec with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

dusDatabases :: Lens' DBUpdateSpec [DatabaseSpec] Source

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.

PawsGetSpectrumBatchRequest

data PawsGetSpectrumBatchRequest Source

The request message for a batch available spectrum query protocol.

See: pawsGetSpectrumBatchRequest smart constructor.

Instances

pawsGetSpectrumBatchRequest :: PawsGetSpectrumBatchRequest Source

Creates a value of PawsGetSpectrumBatchRequest with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

pgsbrAntenna :: Lens' PawsGetSpectrumBatchRequest (Maybe AntennaCharacteristics) Source

Depending on device type and regulatory domain, antenna characteristics may be required.

pgsbrMasterDeviceDesc :: Lens' PawsGetSpectrumBatchRequest (Maybe DeviceDescriptor) Source

When an available spectrum batch request is made by the master device (a device with geolocation capability) on behalf of a slave device (a device without geolocation capability), the rules of the applicable regulatory domain may require the master device to provide its own device descriptor information (in addition to device descriptor information for the slave device in a separate parameter).

pgsbrOwner :: Lens' PawsGetSpectrumBatchRequest (Maybe DeviceOwner) Source

Depending on device type and regulatory domain, device owner information may be included in an available spectrum batch request. This allows the device to register and get spectrum-availability information in a single request.

pgsbrRequestType :: Lens' PawsGetSpectrumBatchRequest (Maybe Text) Source

The request type parameter is an optional parameter that can be used to modify an available spectrum batch request, but its use depends on applicable regulatory rules. For example, It may be used to request generic slave device parameters without having to specify the device descriptor for a specific device. When the requestType parameter is missing, the request is for a specific device (master or slave), and the device descriptor parameter for the device on whose behalf the batch request is made is required.

pgsbrVersion :: Lens' PawsGetSpectrumBatchRequest (Maybe Text) Source

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

pgsbrType :: Lens' PawsGetSpectrumBatchRequest (Maybe Text) Source

The message type (e.g., INIT_REQ, AVAIL_SPECTRUM_REQ, ...). Required field.

pgsbrLocations :: Lens' PawsGetSpectrumBatchRequest [GeoLocation] Source

A geolocation list is required. This allows a device to specify its current location plus additional anticipated locations when allowed by the regulatory domain. At least one location must be included. Geolocation must be given as the location of the radiation center of the device's antenna. If a location specifies a region, rather than a point, the database may return an UNIMPLEMENTED error if it does not support query by region. There is no upper limit on the number of locations included in a available spectrum batch request, but the database may restrict the number of locations it supports by returning a response with fewer locations than specified in the batch request. Note that geolocations must be those of the master device (a device with geolocation capability that makes an available spectrum batch request), whether the master device is making the request on its own behalf or on behalf of a slave device (one without geolocation capability).

pgsbrCapabilities :: Lens' PawsGetSpectrumBatchRequest (Maybe DeviceCapabilities) Source

The master device may include its device capabilities to limit the available-spectrum batch response to the spectrum that is compatible with its capabilities. The database should not return spectrum that is incompatible with the specified capabilities.

pgsbrDeviceDesc :: Lens' PawsGetSpectrumBatchRequest (Maybe DeviceDescriptor) Source

When the available spectrum request is made on behalf of a specific device (a master or slave device), device descriptor information for the device on whose behalf the request is made is required (in such cases, the requestType parameter must be empty). When a requestType value is specified, device descriptor information may be optional or required according to the rules of the applicable regulatory domain.

GeoSpectrumSchedule

data GeoSpectrumSchedule Source

The schedule of spectrum profiles available at a particular geolocation.

See: geoSpectrumSchedule smart constructor.

Instances

geoSpectrumSchedule :: GeoSpectrumSchedule Source

Creates a value of GeoSpectrumSchedule with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

gssLocation :: Lens' GeoSpectrumSchedule (Maybe GeoLocation) Source

The geolocation identifies the location at which the spectrum schedule applies. It will always be present.

gssSpectrumSchedules :: Lens' GeoSpectrumSchedule [SpectrumSchedule] Source

A list of available spectrum profiles and associated times. It will always be present, and at least one schedule must be included (though it may be empty if there is no available spectrum). More than one schedule may be included to represent future changes to the available spectrum.

VcardTypedText

data VcardTypedText Source

The structure used to represent an organization and an email address.

See: vcardTypedText smart constructor.

Instances

vcardTypedText :: VcardTypedText Source

Creates a value of VcardTypedText with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

vttText :: Lens' VcardTypedText (Maybe Text) Source

The text string associated with this item. For example, for an org field: ACME, inc. For an email field: smith'example.com.

SpectrumSchedule

data SpectrumSchedule Source

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

See: spectrumSchedule smart constructor.

Instances

spectrumSchedule :: SpectrumSchedule Source

Creates a value of SpectrumSchedule with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

ssSpectra :: Lens' SpectrumSchedule [SpectrumMessage] Source

A list of spectrum messages representing the usable profile. It will always be present, but may be empty when there is no available spectrum.

ssEventTime :: Lens' SpectrumSchedule (Maybe EventTime) Source

The event time expresses when the spectrum profile is valid. It will always be present.

VcardTelephone

data VcardTelephone Source

The structure used to represent a telephone number.

See: vcardTelephone smart constructor.

Instances

vcardTelephone :: VcardTelephone Source

Creates a value of VcardTelephone with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

vtURI :: Lens' VcardTelephone (Maybe Text) Source

A nested telephone URI of the form: tel:+1-123-456-7890.

DeviceOwner

data DeviceOwner Source

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.

See: deviceOwner smart constructor.

Instances

deviceOwner :: DeviceOwner Source

Creates a value of DeviceOwner with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

doOperator :: Lens' DeviceOwner (Maybe Vcard) Source

The vCard contact information for the device operator is optional, but may be required by specific regulatory domains.

doOwner :: Lens' DeviceOwner (Maybe Vcard) Source

The vCard contact information for the individual or business that owns the device is required.

EventTime

data EventTime Source

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.

See: eventTime smart constructor.

Instances

eventTime :: EventTime Source

Creates a value of EventTime with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

etStartTime :: Lens' EventTime (Maybe Text) Source

The inclusive start of the event. It will be present.

etStopTime :: Lens' EventTime (Maybe Text) Source

The exclusive end of the event. It will be present.

PawsGetSpectrumRequest

data PawsGetSpectrumRequest Source

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

See: pawsGetSpectrumRequest smart constructor.

Instances

pawsGetSpectrumRequest :: PawsGetSpectrumRequest Source

Creates a value of PawsGetSpectrumRequest with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

pgsrAntenna :: Lens' PawsGetSpectrumRequest (Maybe AntennaCharacteristics) Source

Depending on device type and regulatory domain, the characteristics of the antenna may be required.

pgsrMasterDeviceDesc :: Lens' PawsGetSpectrumRequest (Maybe DeviceDescriptor) Source

When an available spectrum request is made by the master device (a device with geolocation capability) on behalf of a slave device (a device without geolocation capability), the rules of the applicable regulatory domain may require the master device to provide its own device descriptor information (in addition to device descriptor information for the slave device, which is provided in a separate parameter).

pgsrLocation :: Lens' PawsGetSpectrumRequest (Maybe GeoLocation) Source

The geolocation of the master device (a device with geolocation capability that makes an available spectrum request) is required whether the master device is making the request on its own behalf or on behalf of a slave device (one without geolocation capability). The location must be the location of the radiation center of the master device's antenna. To support mobile devices, a regulatory domain may allow the anticipated position of the master device to be given instead. If the location specifies a region, rather than a point, the database may return an UNIMPLEMENTED error code if it does not support query by region.

pgsrOwner :: Lens' PawsGetSpectrumRequest (Maybe DeviceOwner) Source

Depending on device type and regulatory domain, device owner information may be included in an available spectrum request. This allows the device to register and get spectrum-availability information in a single request.

pgsrRequestType :: Lens' PawsGetSpectrumRequest (Maybe Text) Source

The request type parameter is an optional parameter that can be used to modify an available spectrum request, but its use depends on applicable regulatory rules. It may be used, for example, to request generic slave device parameters without having to specify the device descriptor for a specific device. When the requestType parameter is missing, the request is for a specific device (master or slave), and the deviceDesc parameter for the device on whose behalf the request is made is required.

pgsrVersion :: Lens' PawsGetSpectrumRequest (Maybe Text) Source

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

pgsrType :: Lens' PawsGetSpectrumRequest (Maybe Text) Source

The message type (e.g., INIT_REQ, AVAIL_SPECTRUM_REQ, ...). Required field.

pgsrCapabilities :: Lens' PawsGetSpectrumRequest (Maybe DeviceCapabilities) Source

The master device may include its device capabilities to limit the available-spectrum response to the spectrum that is compatible with its capabilities. The database should not return spectrum that is incompatible with the specified capabilities.

pgsrDeviceDesc :: Lens' PawsGetSpectrumRequest (Maybe DeviceDescriptor) Source

When the available spectrum request is made on behalf of a specific device (a master or slave device), device descriptor information for that device is required (in such cases, the requestType parameter must be empty). When a requestType value is specified, device descriptor information may be optional or required according to the rules of the applicable regulatory domain.

AntennaCharacteristics

data AntennaCharacteristics Source

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.

See: antennaCharacteristics smart constructor.

Instances

antennaCharacteristics :: AntennaCharacteristics Source

Creates a value of AntennaCharacteristics with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

acHeight :: Lens' AntennaCharacteristics (Maybe Double) Source

The antenna height in meters. Whether the antenna height is required depends on the device type and the regulatory domain. Note that the height may be negative.

acHeightType :: Lens' AntennaCharacteristics (Maybe Text) Source

If the height is required, then the height type (AGL for above ground level or AMSL for above mean sea level) is also required. The default is AGL.

acHeightUncertainty :: Lens' AntennaCharacteristics (Maybe Double) Source

The height uncertainty in meters. Whether this is required depends on the regulatory domain.

PawsVerifyDeviceResponse

data PawsVerifyDeviceResponse Source

The device validation response message.

See: pawsVerifyDeviceResponse smart constructor.

Instances

pawsVerifyDeviceResponse :: PawsVerifyDeviceResponse Source

Creates a value of PawsVerifyDeviceResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

pvdrDeviceValidities :: Lens' PawsVerifyDeviceResponse [DeviceValidity] Source

A device validities list is required in the device validation response to report whether each slave device listed in a previous device validation request is valid. The number of entries must match the number of device descriptors listed in the previous device validation request.

pvdrKind :: Lens' PawsVerifyDeviceResponse Text Source

Identifies what kind of resource this is. Value: the fixed string "spectrum#pawsVerifyDeviceResponse".

pvdrVersion :: Lens' PawsVerifyDeviceResponse (Maybe Text) Source

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

pvdrType :: Lens' PawsVerifyDeviceResponse (Maybe Text) Source

The message type (e.g., INIT_REQ, AVAIL_SPECTRUM_REQ, ...). Required field.

pvdrDatabaseChange :: Lens' PawsVerifyDeviceResponse (Maybe DBUpdateSpec) Source

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.

VcardAddress

data VcardAddress Source

The structure used to represent a street address.

See: vcardAddress smart constructor.

Instances

vcardAddress :: VcardAddress Source

Creates a value of VcardAddress with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

vaPobox :: Lens' VcardAddress (Maybe Text) Source

An optional post office box number.

vaCountry :: Lens' VcardAddress (Maybe Text) Source

The country name. For example: US.

vaStreet :: Lens' VcardAddress (Maybe Text) Source

The street number and name. For example: 123 Any St.

vaLocality :: Lens' VcardAddress (Maybe Text) Source

The city or local equivalent portion of the address. For example: San Jose.

vaCode :: Lens' VcardAddress (Maybe Text) Source

The postal code associated with the address. For example: 94423.

vaRegion :: Lens' VcardAddress (Maybe Text) Source

The state or local equivalent portion of the address. For example: CA.

PawsGetSpectrumBatchResponse

data PawsGetSpectrumBatchResponse Source

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

See: pawsGetSpectrumBatchResponse smart constructor.

Instances

pawsGetSpectrumBatchResponse :: PawsGetSpectrumBatchResponse Source

Creates a value of PawsGetSpectrumBatchResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

pNeedsSpectrumReport :: Lens' PawsGetSpectrumBatchResponse (Maybe Bool) Source

For regulatory domains that require a spectrum-usage report from devices, the database must return true for this parameter if the geo-spectrum schedules list is not empty; otherwise, the database should either return false or omit this parameter. If this parameter is present and its value is true, the device must send a spectrum use notify message to the database; otherwise, the device should not send the notification.

pKind :: Lens' PawsGetSpectrumBatchResponse Text Source

Identifies what kind of resource this is. Value: the fixed string "spectrum#pawsGetSpectrumBatchResponse".

pGeoSpectrumSchedules :: Lens' PawsGetSpectrumBatchResponse [GeoSpectrumSchedule] Source

The available spectrum batch response must contain a geo-spectrum schedule list, The list may be empty if spectrum is not available. The database may return more than one geo-spectrum schedule to represent future changes to the available spectrum. How far in advance a schedule may be provided depends upon the applicable regulatory domain. The database may return available spectrum for fewer geolocations than requested. The device must not make assumptions about the order of the entries in the list, and must use the geolocation value in each geo-spectrum schedule entry to match available spectrum to a location.

pMaxContiguousBwHz :: Lens' PawsGetSpectrumBatchResponse (Maybe Double) Source

The database may return a constraint on the allowed maximum contiguous bandwidth (in Hertz). A regulatory domain may require the database to return this parameter. When this parameter is present in the response, the device must apply this constraint to its spectrum-selection logic to ensure that no single block of spectrum has bandwidth that exceeds this value.

pVersion :: Lens' PawsGetSpectrumBatchResponse (Maybe Text) Source

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

pRulesetInfo :: Lens' PawsGetSpectrumBatchResponse (Maybe RulesetInfo) Source

The database should return ruleset information, which identifies the applicable regulatory authority and ruleset for the available spectrum batch response. If included, the device must use the corresponding ruleset to interpret the response. Values provided in the returned ruleset information, such as maxLocationChange, take precedence over any conflicting values provided in the ruleset information returned in a prior initialization response sent by the database to the device.

pType :: Lens' PawsGetSpectrumBatchResponse (Maybe Text) Source

The message type (e.g., INIT_REQ, AVAIL_SPECTRUM_REQ, ...). Required field.

pDatabaseChange :: Lens' PawsGetSpectrumBatchResponse (Maybe DBUpdateSpec) Source

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.

pTimestamp :: Lens' PawsGetSpectrumBatchResponse (Maybe Text) Source

The database includes a timestamp of the form, YYYY-MM-DDThh:mm:ssZ (Internet timestamp format per RFC3339), in its available spectrum batch response. The timestamp should be used by the device as a reference for the start and stop times specified in the response spectrum schedules.

pDeviceDesc :: Lens' PawsGetSpectrumBatchResponse (Maybe DeviceDescriptor) Source

The database must return in its available spectrum response the device descriptor information it received in the master device's available spectrum batch request.

pMaxTotalBwHz :: Lens' PawsGetSpectrumBatchResponse (Maybe Double) Source

The database may return a constraint on the allowed maximum total bandwidth (in Hertz), which does not need to be contiguous. A regulatory domain may require the database to return this parameter. When this parameter is present in the available spectrum batch response, the device must apply this constraint to its spectrum-selection logic to ensure that total bandwidth does not exceed this value.

DeviceValidity

data DeviceValidity Source

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

See: deviceValidity smart constructor.

Instances

deviceValidity :: DeviceValidity Source

Creates a value of DeviceValidity with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

dvIsValid :: Lens' DeviceValidity (Maybe Bool) Source

The validity status: true if the device is valid for operation, false otherwise. It will always be present.

dvReason :: Lens' DeviceValidity (Maybe Text) Source

If the device identifier is not valid, the database may include a reason. The reason may be in any language. The length of the value should not exceed 128 characters.

dvDeviceDesc :: Lens' DeviceValidity (Maybe DeviceDescriptor) Source

The descriptor of the device for which the validity check was requested. It will always be present.

GeoLocationEllipse

data GeoLocationEllipse Source

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

See: geoLocationEllipse smart constructor.

Instances

geoLocationEllipse :: GeoLocationEllipse Source

Creates a value of GeoLocationEllipse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

gleSemiMajorAxis :: Lens' GeoLocationEllipse (Maybe Double) Source

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.

gleCenter :: Lens' GeoLocationEllipse (Maybe GeoLocationPoint) Source

A required geo-spatial point representing the center of the ellipse.

gleOrientation :: Lens' GeoLocationEllipse (Maybe Double) Source

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.

gleSemiMinorAxis :: Lens' GeoLocationEllipse (Maybe Double) Source

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.

RulesetInfo

data RulesetInfo Source

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

See: rulesetInfo smart constructor.

Instances

rulesetInfo :: RulesetInfo Source

Creates a value of RulesetInfo with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

riRulesetIds :: Lens' RulesetInfo [Text] Source

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.

riMaxPollingSecs :: Lens' RulesetInfo (Maybe Int32) Source

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.

riMaxLocationChange :: Lens' RulesetInfo (Maybe Double) Source

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.

riAuthority :: Lens' RulesetInfo (Maybe Text) Source

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.

PawsRegisterRequest

data PawsRegisterRequest Source

The registration request message contains the required registration parameters.

See: pawsRegisterRequest smart constructor.

Instances

pawsRegisterRequest :: PawsRegisterRequest Source

Creates a value of PawsRegisterRequest with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

pawAntenna :: Lens' PawsRegisterRequest (Maybe AntennaCharacteristics) Source

Antenna characteristics, including its height and height type.

pawLocation :: Lens' PawsRegisterRequest (Maybe GeoLocation) Source

A device's geolocation is required.

pawDeviceOwner :: Lens' PawsRegisterRequest (Maybe DeviceOwner) Source

Device owner information is required.

pawVersion :: Lens' PawsRegisterRequest (Maybe Text) Source

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

pawType :: Lens' PawsRegisterRequest (Maybe Text) Source

The message type (e.g., INIT_REQ, AVAIL_SPECTRUM_REQ, ...). Required field.

pawDeviceDesc :: Lens' PawsRegisterRequest (Maybe DeviceDescriptor) Source

A DeviceDescriptor is required.

PawsNotifySpectrumUseResponse

data PawsNotifySpectrumUseResponse Source

An empty response to the notification.

See: pawsNotifySpectrumUseResponse smart constructor.

Instances

pawsNotifySpectrumUseResponse :: PawsNotifySpectrumUseResponse Source

Creates a value of PawsNotifySpectrumUseResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

pnsurnKind :: Lens' PawsNotifySpectrumUseResponse Text Source

Identifies what kind of resource this is. Value: the fixed string "spectrum#pawsNotifySpectrumUseResponse".

pnsurnVersion :: Lens' PawsNotifySpectrumUseResponse (Maybe Text) Source

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

pnsurnType :: Lens' PawsNotifySpectrumUseResponse (Maybe Text) Source

The message type (e.g., INIT_REQ, AVAIL_SPECTRUM_REQ, ...). Required field.

DatabaseSpec

data DatabaseSpec Source

This message contains the name and URI of a database.

See: databaseSpec smart constructor.

Instances

databaseSpec :: DatabaseSpec Source

Creates a value of DatabaseSpec with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

dsURI :: Lens' DatabaseSpec (Maybe Text) Source

The corresponding URI of the database.

dsName :: Lens' DatabaseSpec (Maybe Text) Source

The display name for a database.

SpectrumMessage

data SpectrumMessage Source

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

See: spectrumMessage smart constructor.

Instances

spectrumMessage :: SpectrumMessage Source

Creates a value of SpectrumMessage with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

smBandwidth :: Lens' SpectrumMessage (Maybe Double) Source

The bandwidth (in Hertz) for which permissible power levels are specified. For example, FCC regulation would require only one spectrum specification at 6MHz bandwidth, but Ofcom regulation would require two specifications, at 0.1MHz and 8MHz. This parameter may be empty if there is no available spectrum. It will be present otherwise.

smFrequencyRanges :: Lens' SpectrumMessage [FrequencyRange] Source

The list of frequency ranges and permissible power levels. The list may be empty if there is no available spectrum, otherwise it will be present.

GeoLocation

data GeoLocation Source

This parameter is used to specify the geolocation of the device.

See: geoLocation smart constructor.

Instances

geoLocation :: GeoLocation Source

Creates a value of GeoLocation with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

glConfidence :: Lens' GeoLocation (Maybe Int32) Source

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.

glPoint :: Lens' GeoLocation (Maybe GeoLocationEllipse) Source

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.

glRegion :: Lens' GeoLocation (Maybe GeoLocationPolygon) Source

If present, indicates that the geolocation represents a region. Database support for regions is optional.

FrequencyRange

data FrequencyRange Source

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

See: frequencyRange smart constructor.

Instances

frequencyRange :: FrequencyRange Source

Creates a value of FrequencyRange with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

frStopHz :: Lens' FrequencyRange (Maybe Double) Source

The required exclusive end of the frequency range (in Hertz).

frMaxPowerDBm :: Lens' FrequencyRange (Maybe Double) Source

The maximum total power level (EIRP)—computed over the corresponding operating bandwidth—that is permitted within the frequency range. Depending on the context in which the frequency-range element appears, this value may be required. For example, it is required in the available-spectrum response, available-spectrum-batch response, and spectrum-use notification message, but it should not be present (it is not applicable) when the frequency range appears inside a device-capabilities message.

frChannelId :: Lens' FrequencyRange (Maybe Text) Source

The database may include a channel identifier, when applicable. When it is included, the device should treat it as informative. The length of the identifier should not exceed 16 characters.

frStartHz :: Lens' FrequencyRange (Maybe Double) Source

The required inclusive start of the frequency range (in Hertz).

PawsGetSpectrumResponse

data PawsGetSpectrumResponse Source

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

See: pawsGetSpectrumResponse smart constructor.

Instances

pawsGetSpectrumResponse :: PawsGetSpectrumResponse Source

Creates a value of PawsGetSpectrumResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

pgsrgNeedsSpectrumReport :: Lens' PawsGetSpectrumResponse (Maybe Bool) Source

For regulatory domains that require a spectrum-usage report from devices, the database must return true for this parameter if the spectrum schedule list is not empty; otherwise, the database will either return false or omit this parameter. If this parameter is present and its value is true, the device must send a spectrum use notify message to the database; otherwise, the device must not send the notification.

pgsrgSpectrumSchedules :: Lens' PawsGetSpectrumResponse [SpectrumSchedule] Source

The available spectrum response must contain a spectrum schedule list. The list may be empty if spectrum is not available. The database may return more than one spectrum schedule to represent future changes to the available spectrum. How far in advance a schedule may be provided depends on the applicable regulatory domain.

pgsrgKind :: Lens' PawsGetSpectrumResponse Text Source

Identifies what kind of resource this is. Value: the fixed string "spectrum#pawsGetSpectrumResponse".

pgsrgMaxContiguousBwHz :: Lens' PawsGetSpectrumResponse (Maybe Double) Source

The database may return a constraint on the allowed maximum contiguous bandwidth (in Hertz). A regulatory domain may require the database to return this parameter. When this parameter is present in the response, the device must apply this constraint to its spectrum-selection logic to ensure that no single block of spectrum has bandwidth that exceeds this value.

pgsrgVersion :: Lens' PawsGetSpectrumResponse (Maybe Text) Source

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

pgsrgRulesetInfo :: Lens' PawsGetSpectrumResponse (Maybe RulesetInfo) Source

The database should return ruleset information, which identifies the applicable regulatory authority and ruleset for the available spectrum response. If included, the device must use the corresponding ruleset to interpret the response. Values provided in the returned ruleset information, such as maxLocationChange, take precedence over any conflicting values provided in the ruleset information returned in a prior initialization response sent by the database to the device.

pgsrgType :: Lens' PawsGetSpectrumResponse (Maybe Text) Source

The message type (e.g., INIT_REQ, AVAIL_SPECTRUM_REQ, ...). Required field.

pgsrgDatabaseChange :: Lens' PawsGetSpectrumResponse (Maybe DBUpdateSpec) Source

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.

pgsrgTimestamp :: Lens' PawsGetSpectrumResponse (Maybe Text) Source

The database includes a timestamp of the form YYYY-MM-DDThh:mm:ssZ (Internet timestamp format per RFC3339) in its available spectrum response. The timestamp should be used by the device as a reference for the start and stop times specified in the response spectrum schedules.

pgsrgDeviceDesc :: Lens' PawsGetSpectrumResponse (Maybe DeviceDescriptor) Source

The database must return, in its available spectrum response, the device descriptor information it received in the master device's available spectrum request.

pgsrgMaxTotalBwHz :: Lens' PawsGetSpectrumResponse (Maybe Double) Source

The database may return a constraint on the allowed maximum total bandwidth (in Hertz), which need not be contiguous. A regulatory domain may require the database to return this parameter. When this parameter is present in the available spectrum response, the device must apply this constraint to its spectrum-selection logic to ensure that total bandwidth does not exceed this value.

PawsVerifyDeviceRequest

data PawsVerifyDeviceRequest Source

The device validation request message.

See: pawsVerifyDeviceRequest smart constructor.

Instances

pawsVerifyDeviceRequest :: PawsVerifyDeviceRequest Source

Creates a value of PawsVerifyDeviceRequest with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

pvdrvVersion :: Lens' PawsVerifyDeviceRequest (Maybe Text) Source

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

pvdrvDeviceDescs :: Lens' PawsVerifyDeviceRequest [DeviceDescriptor] Source

A list of device descriptors, which specifies the slave devices to be validated, is required.

pvdrvType :: Lens' PawsVerifyDeviceRequest (Maybe Text) Source

The message type (e.g., INIT_REQ, AVAIL_SPECTRUM_REQ, ...). Required field.

DeviceDescriptor

data DeviceDescriptor Source

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.

See: deviceDescriptor smart constructor.

Instances

deviceDescriptor :: DeviceDescriptor Source

Creates a value of DeviceDescriptor with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

ddEtsiEnDeviceEmissionsClass :: Lens' DeviceDescriptor (Maybe Text) Source

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.

ddRulesetIds :: Lens' DeviceDescriptor [Text] Source

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.

ddModelId :: Lens' DeviceDescriptor (Maybe Text) Source

The device's model ID may be required by the regulatory domain. The string value must not exceed 64 characters in length.

ddEtsiEnDeviceType :: Lens' DeviceDescriptor (Maybe Text) Source

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.

ddEtsiEnTechnologyId :: Lens' DeviceDescriptor (Maybe Text) Source

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.

ddFccId :: Lens' DeviceDescriptor (Maybe Text) Source

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.

ddManufacturerId :: Lens' DeviceDescriptor (Maybe Text) Source

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.

ddFccTvbdDeviceType :: Lens' DeviceDescriptor (Maybe Text) Source

Specifies the TV Band White Space device type, as defined by the FCC. Valid values are FIXED, MODE_1, MODE_2.

ddEtsiEnDeviceCategory :: Lens' DeviceDescriptor (Maybe Text) Source

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.

ddSerialNumber :: Lens' DeviceDescriptor (Maybe Text) Source

The manufacturer's device serial number; required by the applicable regulatory domain. The length of the value must not exceed 64 characters.

PawsInitRequest

data PawsInitRequest Source

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

See: pawsInitRequest smart constructor.

Instances

pawsInitRequest :: PawsInitRequest Source

Creates a value of PawsInitRequest with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

piriLocation :: Lens' PawsInitRequest (Maybe GeoLocation) Source

A device's geolocation is required.

piriVersion :: Lens' PawsInitRequest (Maybe Text) Source

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

piriType :: Lens' PawsInitRequest (Maybe Text) Source

The message type (e.g., INIT_REQ, AVAIL_SPECTRUM_REQ, ...). Required field.

piriDeviceDesc :: Lens' PawsInitRequest (Maybe DeviceDescriptor) Source

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.

DeviceCapabilities

data DeviceCapabilities Source

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.

See: deviceCapabilities smart constructor.

Instances

deviceCapabilities :: DeviceCapabilities Source

Creates a value of DeviceCapabilities with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

dcFrequencyRanges :: Lens' DeviceCapabilities [FrequencyRange] Source

An optional list of frequency ranges supported by the device. Each element must contain start and stop frequencies in which the device can operate. Channel identifiers are optional. When specified, the database should not return available spectrum that falls outside these ranges or channel IDs.