Skip to content

Commit

Permalink
editorial: Fix requestedSamplingFrequency's description (#485)
Browse files Browse the repository at this point in the history 
SHA: aab0ee4
Reason: push, by rakuco

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
  • Loading branch information
@github-actions
Raphael Kubo da Costa and github-actions[bot] committed Feb 20, 2024
1 parent 39ccf27 commit adee5a7
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<link href="https://www.w3.org/StyleSheets/TR/2021/W3C-ED" rel="stylesheet">
<meta content="Bikeshed version 82ce88815, updated Thu Sep 7 16:33:55 2023 -0700" name="generator">
<link href="https://www.w3.org/TR/generic-sensor/" rel="canonical">
<meta content="738e124a8a54b2cf21127f914cecbcd61c35b4da" name="document-revision">
<meta content="aab0ee453a312ad09b7ce54a94cabf685f3c8c84" name="document-revision">
<style>
svg g.edge text {
font-size: 8px;
Expand Down Expand Up @@ -911,7 +911,7 @@
<div class="head">
<p data-fill-with="logo"><a class="logo" href="https://www.w3.org/"> <img alt="W3C" height="48" src="https://www.w3.org/StyleSheets/TR/2021/logos/W3C" width="72"> </a> </p>
<h1 class="p-name no-ref" id="title">Generic Sensor API</h1>
<p id="w3c-state"><a href="https://www.w3.org/standards/types#ED">Editor’s Draft</a>, <time class="dt-updated" datetime="2024-02-17">17 February 2024</time></p>
<p id="w3c-state"><a href="https://www.w3.org/standards/types#ED">Editor’s Draft</a>, <time class="dt-updated" datetime="2024-02-20">20 February 2024</time></p>
<details open>
<summary>More details about this document</summary>
<div data-fill-with="spec-metadata">
Expand Down Expand Up @@ -2663,10 +2663,10 @@ <h4 class="heading settled" data-level="9.2.2" id="get-virtual-sensor-informatio
<tr>
<td>"<code>requestedSamplingFrequency</code>"
<td><code class="idl"><a data-link-type="idl" href="https://tc39.es/ecma262/multipage/numbers-and-dates.html#sec-number-objects" id="ref-for-sec-number-objects④">Number</a></code>
<td>The <a data-link-type="dfn" href="#virtual-sensor" id="ref-for-virtual-sensor①⑦">virtual sensor</a>'s <a data-link-type="dfn" href="#sampling-frequency" id="ref-for-sampling-frequency①④">sampling frequency</a>
<td>The <a data-link-type="dfn" href="#virtual-sensor" id="ref-for-virtual-sensor①⑦">virtual sensor</a>'s <a data-link-type="dfn" href="#virtual-sensor-requested-sampling-frequency" id="ref-for-virtual-sensor-requested-sampling-frequency③">requested sampling frequency</a>
</table>
<p class="note" role="note"><span class="marker">Note:</span> See <a href="#concepts-sampling-and-reporting-frequencies">§ 5.4 Sampling Frequency and Reporting Frequency</a> for some constraints on <a data-link-type="dfn" href="#sampling-frequency" id="ref-for-sampling-frequency①⑤">sampling
frequency</a> as well as the explanation about why a <a data-link-type="dfn" href="#virtual-sensor-requested-sampling-frequency" id="ref-for-virtual-sensor-requested-sampling-frequency③">requested sampling frequency</a> is an <a data-link-type="dfn" href="https://infra.spec.whatwg.org/#implementation-defined" id="ref-for-implementation-defined①①">implementation-defined</a> value in <a href="#virtual-sensors">§ 9.1 Virtual Sensors</a>. In general, it is only safe to
<p class="note" role="note"><span class="marker">Note:</span> See <a href="#concepts-sampling-and-reporting-frequencies">§ 5.4 Sampling Frequency and Reporting Frequency</a> for some constraints on <a data-link-type="dfn" href="#sampling-frequency" id="ref-for-sampling-frequency①④">sampling
frequency</a> as well as the explanation about why a <a data-link-type="dfn" href="#virtual-sensor-requested-sampling-frequency" id="ref-for-virtual-sensor-requested-sampling-frequency④">requested sampling frequency</a> is an <a data-link-type="dfn" href="https://infra.spec.whatwg.org/#implementation-defined" id="ref-for-implementation-defined①①">implementation-defined</a> value in <a href="#virtual-sensors">§ 9.1 Virtual Sensors</a>. In general, it is only safe to
assume that the value lies within the bounds set by the <a data-link-type="dfn" href="#virtual-sensor" id="ref-for-virtual-sensor①⑧">virtual sensor</a>'s <a data-link-type="dfn" href="#virtual-sensor-minimum-sampling-frequency" id="ref-for-virtual-sensor-minimum-sampling-frequency②">minimum sampling frequency</a> and <a data-link-type="dfn" href="#virtual-sensor-maximum-sampling-frequency" id="ref-for-virtual-sensor-maximum-sampling-frequency②">maximum sampling frequency</a>.</p>
<div class="algorithm" data-algorithm="get virtual sensor information">
The <a data-link-type="dfn" href="https://w3c.github.io/webdriver/#dfn-remote-end-steps" id="ref-for-dfn-remote-end-steps①">remote end steps</a> are:
Expand All @@ -2682,7 +2682,7 @@ <h4 class="heading settled" data-level="9.2.2" id="get-virtual-sensor-informatio
<li data-md>
<p>Let <var>info</var> be a new <code class="idl"><a data-link-type="idl" href="https://tc39.es/ecma262/multipage/fundamental-objects.html#sec-object-objects" id="ref-for-sec-object-objects②">Object</a></code>.</p>
<li data-md>
<p>Invoke <a data-link-type="dfn" href="https://w3c.github.io/webdriver/#dfn-set-a-property" id="ref-for-dfn-set-a-property">set a property</a> on <var>info</var> with "<code>requestedSamplingFrequency</code>" and <var>virtualSensor</var>’s <a data-link-type="dfn" href="#virtual-sensor-requested-sampling-frequency" id="ref-for-virtual-sensor-requested-sampling-frequency④">requested sampling frequency</a>.</p>
<p>Invoke <a data-link-type="dfn" href="https://w3c.github.io/webdriver/#dfn-set-a-property" id="ref-for-dfn-set-a-property">set a property</a> on <var>info</var> with "<code>requestedSamplingFrequency</code>" and <var>virtualSensor</var>’s <a data-link-type="dfn" href="#virtual-sensor-requested-sampling-frequency" id="ref-for-virtual-sensor-requested-sampling-frequency⑤">requested sampling frequency</a>.</p>
<li data-md>
<p>Return <a data-link-type="dfn" href="https://w3c.github.io/webdriver/#dfn-success" id="ref-for-dfn-success③">success</a> with data <var>info</var>.</p>
</ol>
Expand Down Expand Up @@ -2996,7 +2996,7 @@ <h3 class="heading settled" data-level="10.8" id="permission-api"><span class="s
magnetic field. In contrast, relative orientation sensor does not expose such information, thus,
it does not need to <a data-link-type="dfn" href="https://w3c.github.io/permissions/#dfn-request-permission-to-use" id="ref-for-dfn-request-permission-to-use③">request permission to use</a> magnetometer.</p>
<p><code class="idl"><a data-link-type="idl" href="https://w3c.github.io/permissions/#dom-permissiondescriptor" id="ref-for-dom-permissiondescriptor①">Permission descriptors</a></code> can also be used to set maximum allowed limits
for accuracy or <a data-link-type="dfn" href="#sampling-frequency" id="ref-for-sampling-frequency①⑥">sampling frequency</a>. An example for a possible extension of the Permission API
for accuracy or <a data-link-type="dfn" href="#sampling-frequency" id="ref-for-sampling-frequency①⑤">sampling frequency</a>. An example for a possible extension of the Permission API
for accelerometer sensor is given below.</p>
<pre class="example highlight" id="example-88a9149d"><a class="self-link" href="#example-88a9149d"></a><c- b>dictionary</c-> <c- g>AccelerometerPermissionDescriptor</c-> : <c- n>PermissionDescriptor</c-> {
<c- b>boolean</c-> <c- g>highAccuracy</c-> = <c- b>false</c->;
Expand Down Expand Up @@ -4350,7 +4350,7 @@ <h2 class="no-num no-ref heading settled" id="idl-index"><span class="content">I
window.dfnpanelData['high-level'] = {"dfnID": "high-level", "url": "#high-level", "dfnText": "high-level", "refSections": [{"refs": [{"id": "ref-for-high-level"}], "title": "1. Introduction"}, {"refs": [{"id": "ref-for-high-level\u2460"}, {"id": "ref-for-high-level\u2461"}, {"id": "ref-for-high-level\u2462"}, {"id": "ref-for-high-level\u2463"}, {"id": "ref-for-high-level\u2464"}, {"id": "ref-for-high-level\u2465"}], "title": "5.2. Sensor Types"}, {"refs": [{"id": "ref-for-high-level\u2466"}], "title": "10. Extensibility"}, {"refs": [{"id": "ref-for-high-level\u2467"}], "title": "10.2. Naming"}, {"refs": [{"id": "ref-for-high-level\u2468"}, {"id": "ref-for-high-level\u2460\u24ea"}, {"id": "ref-for-high-level\u2460\u2460"}], "title": "10.4. Exposing High-Level vs. Low-Level Sensors"}], "external": false};
window.dfnpanelData['sensor-fusion'] = {"dfnID": "sensor-fusion", "url": "#sensor-fusion", "dfnText": "sensor fusion", "refSections": [{"refs": [{"id": "ref-for-sensor-fusion"}, {"id": "ref-for-sensor-fusion\u2460"}, {"id": "ref-for-sensor-fusion\u2461"}], "title": "5.1. Sensors"}, {"refs": [{"id": "ref-for-sensor-fusion\u2462"}, {"id": "ref-for-sensor-fusion\u2463"}, {"id": "ref-for-sensor-fusion\u2464"}, {"id": "ref-for-sensor-fusion\u2465"}, {"id": "ref-for-sensor-fusion\u2466"}], "title": "5.2. Sensor Types"}, {"refs": [{"id": "ref-for-sensor-fusion\u2467"}], "title": "10.6. Definition Requirements"}, {"refs": [{"id": "ref-for-sensor-fusion\u2468"}], "title": "10.8. Extending the Permission API"}, {"refs": [{"id": "ref-for-sensor-fusion\u2460\u24ea"}, {"id": "ref-for-sensor-fusion\u2460\u2460"}], "title": "10.9. Extending the Permissions Policy API"}], "external": false};
window.dfnpanelData['default-sensor'] = {"dfnID": "default-sensor", "url": "#default-sensor", "dfnText": "default sensor", "refSections": [{"refs": [{"id": "ref-for-default-sensor"}, {"id": "ref-for-default-sensor\u2460"}, {"id": "ref-for-default-sensor\u2461"}], "title": "5.3. Default sensor"}, {"refs": [{"id": "ref-for-default-sensor\u2462"}], "title": "6.1. Sensor Type"}, {"refs": [{"id": "ref-for-default-sensor\u2463"}, {"id": "ref-for-default-sensor\u2464"}], "title": "8.3. Connect to sensor"}, {"refs": [{"id": "ref-for-default-sensor\u2465"}, {"id": "ref-for-default-sensor\u2466"}, {"id": "ref-for-default-sensor\u2467"}], "title": "10.6. Definition Requirements"}], "external": false};
window.dfnpanelData['sampling-frequency'] = {"dfnID": "sampling-frequency", "url": "#sampling-frequency", "dfnText": "sampling frequency", "refSections": [{"refs": [{"id": "ref-for-sampling-frequency"}, {"id": "ref-for-sampling-frequency\u2460"}], "title": "4.3.3. Limit number of delivered readings"}, {"refs": [{"id": "ref-for-sampling-frequency\u2461"}, {"id": "ref-for-sampling-frequency\u2462"}, {"id": "ref-for-sampling-frequency\u2463"}, {"id": "ref-for-sampling-frequency\u2464"}, {"id": "ref-for-sampling-frequency\u2465"}, {"id": "ref-for-sampling-frequency\u2466"}, {"id": "ref-for-sampling-frequency\u2467"}], "title": "5.4. Sampling Frequency and Reporting Frequency"}, {"refs": [{"id": "ref-for-sampling-frequency\u2468"}], "title": "6.2. Sensor"}, {"refs": [{"id": "ref-for-sampling-frequency\u2460\u24ea"}], "title": "7.1.3. Sensor internal slots"}, {"refs": [{"id": "ref-for-sampling-frequency\u2460\u2460"}, {"id": "ref-for-sampling-frequency\u2460\u2461"}, {"id": "ref-for-sampling-frequency\u2460\u2462"}], "title": "8.7. Set sensor settings"}, {"refs": [{"id": "ref-for-sampling-frequency\u2460\u2463"}, {"id": "ref-for-sampling-frequency\u2460\u2464"}], "title": "9.2.2. Get virtual sensor information"}, {"refs": [{"id": "ref-for-sampling-frequency\u2460\u2465"}], "title": "10.8. Extending the Permission API"}], "external": false};
window.dfnpanelData['sampling-frequency'] = {"dfnID": "sampling-frequency", "url": "#sampling-frequency", "dfnText": "sampling frequency", "refSections": [{"refs": [{"id": "ref-for-sampling-frequency"}, {"id": "ref-for-sampling-frequency\u2460"}], "title": "4.3.3. Limit number of delivered readings"}, {"refs": [{"id": "ref-for-sampling-frequency\u2461"}, {"id": "ref-for-sampling-frequency\u2462"}, {"id": "ref-for-sampling-frequency\u2463"}, {"id": "ref-for-sampling-frequency\u2464"}, {"id": "ref-for-sampling-frequency\u2465"}, {"id": "ref-for-sampling-frequency\u2466"}, {"id": "ref-for-sampling-frequency\u2467"}], "title": "5.4. Sampling Frequency and Reporting Frequency"}, {"refs": [{"id": "ref-for-sampling-frequency\u2468"}], "title": "6.2. Sensor"}, {"refs": [{"id": "ref-for-sampling-frequency\u2460\u24ea"}], "title": "7.1.3. Sensor internal slots"}, {"refs": [{"id": "ref-for-sampling-frequency\u2460\u2460"}, {"id": "ref-for-sampling-frequency\u2460\u2461"}, {"id": "ref-for-sampling-frequency\u2460\u2462"}], "title": "8.7. Set sensor settings"}, {"refs": [{"id": "ref-for-sampling-frequency\u2460\u2463"}], "title": "9.2.2. Get virtual sensor information"}, {"refs": [{"id": "ref-for-sampling-frequency\u2460\u2464"}], "title": "10.8. Extending the Permission API"}], "external": false};
window.dfnpanelData['device-sensor-minimum-sampling-frequency'] = {"dfnID": "device-sensor-minimum-sampling-frequency", "url": "#device-sensor-minimum-sampling-frequency", "dfnText": "minimum sampling frequency", "refSections": [{"refs": [{"id": "ref-for-device-sensor-minimum-sampling-frequency"}, {"id": "ref-for-device-sensor-minimum-sampling-frequency\u2460"}], "title": "5.4. Sampling Frequency and Reporting Frequency"}, {"refs": [{"id": "ref-for-device-sensor-minimum-sampling-frequency\u2461"}], "title": "6.2. Sensor"}, {"refs": [{"id": "ref-for-device-sensor-minimum-sampling-frequency\u2462"}], "title": "9.1. Virtual Sensors"}], "external": false};
window.dfnpanelData['device-sensor-maximum-sampling-frequency'] = {"dfnID": "device-sensor-maximum-sampling-frequency", "url": "#device-sensor-maximum-sampling-frequency", "dfnText": "maximum sampling frequency", "refSections": [{"refs": [{"id": "ref-for-device-sensor-maximum-sampling-frequency"}, {"id": "ref-for-device-sensor-maximum-sampling-frequency\u2460"}, {"id": "ref-for-device-sensor-maximum-sampling-frequency\u2461"}], "title": "5.4. Sampling Frequency and Reporting Frequency"}, {"refs": [{"id": "ref-for-device-sensor-maximum-sampling-frequency\u2462"}], "title": "6.2. Sensor"}, {"refs": [{"id": "ref-for-device-sensor-maximum-sampling-frequency\u2463"}], "title": "9.1. Virtual Sensors"}], "external": false};
window.dfnpanelData['reporting-frequency'] = {"dfnID": "reporting-frequency", "url": "#reporting-frequency", "dfnText": "reporting frequency", "refSections": [{"refs": [{"id": "ref-for-reporting-frequency"}, {"id": "ref-for-reporting-frequency\u2460"}], "title": "5.4. Sampling Frequency and Reporting Frequency"}, {"refs": [{"id": "ref-for-reporting-frequency\u2461"}], "title": "7.1.3. Sensor internal slots"}], "external": false};
Expand Down Expand Up @@ -4401,7 +4401,7 @@ <h2 class="no-num no-ref heading settled" id="idl-index"><span class="content">I
window.dfnpanelData['focus-and-origin-check'] = {"dfnID": "focus-and-origin-check", "url": "#focus-and-origin-check", "dfnText": "8.15. Focus and origin check", "refSections": [{"refs": [{"id": "ref-for-focus-and-origin-check"}], "title": "4.2.3. Focused Area"}, {"refs": [{"id": "ref-for-focus-and-origin-check\u2460"}], "title": "5.5. Conditions to expose sensor readings"}, {"refs": [{"id": "ref-for-focus-and-origin-check"}], "title": "8.15. Focus and origin check"}], "external": false};
window.dfnpanelData['virtual-sensor'] = {"dfnID": "virtual-sensor", "url": "#virtual-sensor", "dfnText": "virtual sensor", "refSections": [{"refs": [{"id": "ref-for-virtual-sensor"}, {"id": "ref-for-virtual-sensor\u2460"}], "title": "9. Automation"}, {"refs": [{"id": "ref-for-virtual-sensor\u2461"}, {"id": "ref-for-virtual-sensor\u2462"}, {"id": "ref-for-virtual-sensor\u2463"}, {"id": "ref-for-virtual-sensor\u2464"}, {"id": "ref-for-virtual-sensor\u2465"}, {"id": "ref-for-virtual-sensor\u2466"}, {"id": "ref-for-virtual-sensor\u2467"}, {"id": "ref-for-virtual-sensor\u2468"}, {"id": "ref-for-virtual-sensor\u2460\u24ea"}], "title": "9.1. Virtual Sensors"}, {"refs": [{"id": "ref-for-virtual-sensor\u2460\u2460"}, {"id": "ref-for-virtual-sensor\u2460\u2461"}, {"id": "ref-for-virtual-sensor\u2460\u2462"}, {"id": "ref-for-virtual-sensor\u2460\u2463"}, {"id": "ref-for-virtual-sensor\u2460\u2464"}], "title": "9.2.1. Create virtual sensor"}, {"refs": [{"id": "ref-for-virtual-sensor\u2460\u2465"}, {"id": "ref-for-virtual-sensor\u2460\u2466"}, {"id": "ref-for-virtual-sensor\u2460\u2467"}], "title": "9.2.2. Get virtual sensor information"}, {"refs": [{"id": "ref-for-virtual-sensor\u2460\u2468"}], "title": "9.2.3. Update virtual sensor reading"}, {"refs": [{"id": "ref-for-virtual-sensor\u2461\u24ea"}], "title": "9.2.4. Delete virtual sensor"}], "external": false};
window.dfnpanelData['virtual-sensor-can-provide-readings-flag'] = {"dfnID": "virtual-sensor-can-provide-readings-flag", "url": "#virtual-sensor-can-provide-readings-flag", "dfnText": "can provide readings flag", "refSections": [{"refs": [{"id": "ref-for-virtual-sensor-can-provide-readings-flag"}, {"id": "ref-for-virtual-sensor-can-provide-readings-flag\u2460"}], "title": "8.3. Connect to sensor"}, {"refs": [{"id": "ref-for-virtual-sensor-can-provide-readings-flag\u2461"}], "title": "9.2.1. Create virtual sensor"}], "external": false};
window.dfnpanelData['virtual-sensor-requested-sampling-frequency'] = {"dfnID": "virtual-sensor-requested-sampling-frequency", "url": "#virtual-sensor-requested-sampling-frequency", "dfnText": "requested sampling frequency", "refSections": [{"refs": [{"id": "ref-for-virtual-sensor-requested-sampling-frequency"}, {"id": "ref-for-virtual-sensor-requested-sampling-frequency\u2460"}, {"id": "ref-for-virtual-sensor-requested-sampling-frequency\u2461"}], "title": "9.1. Virtual Sensors"}, {"refs": [{"id": "ref-for-virtual-sensor-requested-sampling-frequency\u2462"}, {"id": "ref-for-virtual-sensor-requested-sampling-frequency\u2463"}], "title": "9.2.2. Get virtual sensor information"}], "external": false};
window.dfnpanelData['virtual-sensor-requested-sampling-frequency'] = {"dfnID": "virtual-sensor-requested-sampling-frequency", "url": "#virtual-sensor-requested-sampling-frequency", "dfnText": "requested sampling frequency", "refSections": [{"refs": [{"id": "ref-for-virtual-sensor-requested-sampling-frequency"}, {"id": "ref-for-virtual-sensor-requested-sampling-frequency\u2460"}, {"id": "ref-for-virtual-sensor-requested-sampling-frequency\u2461"}], "title": "9.1. Virtual Sensors"}, {"refs": [{"id": "ref-for-virtual-sensor-requested-sampling-frequency\u2462"}, {"id": "ref-for-virtual-sensor-requested-sampling-frequency\u2463"}, {"id": "ref-for-virtual-sensor-requested-sampling-frequency\u2464"}], "title": "9.2.2. Get virtual sensor information"}], "external": false};
window.dfnpanelData['virtual-sensor-minimum-sampling-frequency'] = {"dfnID": "virtual-sensor-minimum-sampling-frequency", "url": "#virtual-sensor-minimum-sampling-frequency", "dfnText": "minimum sampling frequency", "refSections": [{"refs": [{"id": "ref-for-virtual-sensor-minimum-sampling-frequency"}], "title": "9.1. Virtual Sensors"}, {"refs": [{"id": "ref-for-virtual-sensor-minimum-sampling-frequency\u2460"}], "title": "9.2.1. Create virtual sensor"}, {"refs": [{"id": "ref-for-virtual-sensor-minimum-sampling-frequency\u2461"}], "title": "9.2.2. Get virtual sensor information"}], "external": false};
window.dfnpanelData['virtual-sensor-maximum-sampling-frequency'] = {"dfnID": "virtual-sensor-maximum-sampling-frequency", "url": "#virtual-sensor-maximum-sampling-frequency", "dfnText": "maximum sampling frequency", "refSections": [{"refs": [{"id": "ref-for-virtual-sensor-maximum-sampling-frequency"}], "title": "9.1. Virtual Sensors"}, {"refs": [{"id": "ref-for-virtual-sensor-maximum-sampling-frequency\u2460"}], "title": "9.2.1. Create virtual sensor"}, {"refs": [{"id": "ref-for-virtual-sensor-maximum-sampling-frequency\u2461"}], "title": "9.2.2. Get virtual sensor information"}], "external": false};
window.dfnpanelData['virtual-sensor-type'] = {"dfnID": "virtual-sensor-type", "url": "#virtual-sensor-type", "dfnText": "virtual sensor type", "refSections": [{"refs": [{"id": "ref-for-virtual-sensor-type"}], "title": "6.1. Sensor Type"}, {"refs": [{"id": "ref-for-virtual-sensor-type\u2460"}], "title": "8.3. Connect to sensor"}, {"refs": [{"id": "ref-for-virtual-sensor-type\u2461"}, {"id": "ref-for-virtual-sensor-type\u2462"}], "title": "9.1. Virtual Sensors"}, {"refs": [{"id": "ref-for-virtual-sensor-type\u2463"}, {"id": "ref-for-virtual-sensor-type\u2464"}], "title": "10.7. Automation"}], "external": false};
Expand Down

0 comments on commit adee5a7

Please sign in to comment.