Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rewrite Automation section after w3c/sensors#470 #57

Merged
merged 5 commits into from
Oct 26, 2023
Merged

Rewrite Automation section after w3c/sensors#470 #57

Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e89568c
Rewrite Automation section after w3c/sensors#470
JuhaVainio Oct 25, 2023
28ddd12
Change handling of key from map to list. Use "get a property" for "near"
JuhaVainio Oct 25, 2023
8eb1313
Change list format from map to list
JuhaVainio Oct 25, 2023
0e039e6
Fix style of parameter
JuhaVainio Oct 26, 2023
d50353b
Fix the wrong variable name (keys to key)
JuhaVainio Oct 26, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 29 additions & 17 deletions index.bs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,9 @@ urlPrefix: https://w3c.github.io/sensors; spec: GENERIC-SENSOR
text: fingerprinting; url: device-fingerprinting
text: user identifying; url: user-identifying
text: mitigation strategies; url: mitigation-strategies
text: automation
text: mock sensor type
text: mock sensor reading values
urlPrefix: https://w3c.github.io/webdriver/; spec: WEBDRIVER2
type: dfn
text: get a property; url: dfn-getting-properties
</pre>
<pre class="link-defaults">
spec:infra;
Expand Down Expand Up @@ -199,23 +199,35 @@ Abstract Operations {#abstract-operations}

Automation {#automation}
==========
This section extends the [=automation=] section defined in the Generic Sensor API [[GENERIC-SENSOR]]
to provide mocking information about the proximity level for the purposes of
testing a user agent's implementation of {{ProximitySensor}} API.

<h3 id="mock-proximity-sensor-type">Mock Sensor Type</h3>
This section extends [[GENERIC-SENSOR#automation]] by providing [=Proximity Sensor=]-specific virtual sensor metadata.

The {{ProximitySensor}} class has an associated [=mock sensor type=] which is
<a for="MockSensorType" enum-value>"proximity"</a>, its [=mock sensor reading values=]
dictionary is defined as follows:
The [=per-type virtual sensor metadata=] [=map=] must have the following [=map/entry=]:
: [=map/key=]
:: "`proximity`"
: [=map/value=]
:: A [=virtual sensor metadata=] whose [=virtual sensor metadata/virtual sensor type=] is [=Proximity Sensor=] and [=reading parsing algorithm=] is the [=proximity reading parsing algorithm=].

<pre class="idl">
dictionary ProximityReadingValues {
required double? distance;
required double? max;
required boolean? near;
};
</pre>
<h3 dfn>Proximity reading parsing algorithm</h3>
<div algorithm="proximity reading parsing algorithm">
JuhaVainio marked this conversation as resolved.
Show resolved Hide resolved
: input
:: |parameters|, a JSON {{Object}}
: output
:: A [=sensor reading=] or **undefined**

1. Let |reading| be a new [=sensor reading=].
1. Let |keys| be the [=/list=] « "`distance`", "`max`" ».
1. [=list/For each=] |key| of |keys|
1. Let |value| be the result of invoking [=parse single-value number reading=] with |parameters| and |key|.
1. If |value| is **undefined**.
1. Return **undefined**.
1. [=map/Set=] |reading|[|keys|] to |value|[|keys|].
JuhaVainio marked this conversation as resolved.
Show resolved Hide resolved
1. Let |near| be the result of invoking [=get a property=] from |parameters| with "`near`".
1. If |near|'s type is not Boolean
1. Return **undefined**.
1. [=map/Set=] |reading|["`near`"] to |near|.
1. Return |reading|.
</div>

Limitations of Proximity Sensors {#limitations-proximity-sensors}
========================
Expand Down
Loading