From e89568cc345c73c8f4df3acf01e08a7bd52b777d Mon Sep 17 00:00:00 2001 From: Juha Vainio Date: Wed, 25 Oct 2023 11:11:18 +0300 Subject: [PATCH 1/5] Rewrite Automation section after w3c/sensors#470 The Automation section in the Generic Sensor API specification was rewritten and several terms and concepts have changed. This commit adapts the Proximity Sensor spec to the changes: Remove references to "mock sensor type", "mock sensor reading values" and the "MockSensorType" enum. Define an entry in the per-type virtual sensor metadata map whose key is what used to be the "proximity" entry in MockSensorType and an appropriate virtual sensor metadata entry. This is enough to integrate properly with the Generic Sensor spec and allow Proximity virtual sensors to be created and used. Fixes #56. --- index.bs | 38 +++++++++++++++++++++----------------- 1 file changed, 21 insertions(+), 17 deletions(-) diff --git a/index.bs b/index.bs index 010c0e4..4c7a0a5 100644 --- a/index.bs +++ b/index.bs @@ -43,9 +43,6 @@ 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 
 spec:infra;
@@ -199,23 +196,30 @@ 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.
 
-
Mock Sensor Type

+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
-"proximity", 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 [=proximity reading parsing algorithm=].
 
-
-  dictionary ProximityReadingValues {
-    required double? distance;
-    required double? max;
-    required boolean? near;
-  };
-

+
Proximity reading parsing algorithm

+

+    : input
+    :: |parameters|, a JSON {{Object}}
+    : output
+    :: A [=sensor reading=] or **undefined**
+
+    1.  Let |reading| be a new [=sensor reading=].
+    1.  Let |value| be a new [=sensor reading=].
+    1. Let |key| be the [=/list=] « "`distance`", "`max`", "`near`" ».
+    1.  [=map/For each=] |key| → let |value| be the result of [=parse single-value number reading=] with |parameters| and |key|.
+        1.  If |value| is "undefined".
+            1.  Return "undefined".
+        1.  [=map/Set=] |reading|[|key|] to |value|.
+    1.  Return |reading|.
 
 Limitations of Proximity Sensors {#limitations-proximity-sensors}
 ========================

From 28ddd12525270a98cd6f42f37ec1345a14eb9994 Mon Sep 17 00:00:00 2001
From: Juha Vainio 
Date: Wed, 25 Oct 2023 13:35:02 +0300
Subject: [PATCH 2/5] Change handling of key from map to list. Use "get a
 property" for "near"

Typo fixes.

Changed handling of "key" from map to list.

Changed "key" to "keys".

Use "get a property" operation for "near".
---
 index.bs | 22 +++++++++++++++-------
 1 file changed, 15 insertions(+), 7 deletions(-)

diff --git a/index.bs b/index.bs
index 4c7a0a5..d66baf0 100644
--- a/index.bs
+++ b/index.bs
@@ -43,6 +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
+urlPrefix: https://w3c.github.io/webdriver/; spec: WEBDRIVER2
+  type: dfn
+    text: get a property; url: dfn-getting-properties
 
 spec:infra;
@@ -203,7 +206,7 @@ The [=per-type virtual sensor metadata=] [=map=] must have the following [=map/e
 : [=map/key=]
 :: "`proximity`"
 : [=map/value=]
-:: A [=virtual sensor metadata=] whose [=virtual sensor metadata/virtual sensor type=] is [=Proximity Sensor=] and [=reading parsing algorithm=] is [=proximity reading parsing algorithm=].
+:: A [=virtual sensor metadata=] whose [=virtual sensor metadata/virtual sensor type=] is [=Proximity Sensor=] and [=reading parsing algorithm=] is the [=proximity reading parsing algorithm=].
 
 
Proximity reading parsing algorithm

 

@@ -213,13 +216,18 @@ The [=per-type virtual sensor metadata=] [=map=] must have the following [=map/e
     :: A [=sensor reading=] or **undefined**
 
     1.  Let |reading| be a new [=sensor reading=].
-    1.  Let |value| be a new [=sensor reading=].
-    1. Let |key| be the [=/list=] « "`distance`", "`max`", "`near`" ».
-    1.  [=map/For each=] |key| → let |value| be the result of [=parse single-value number reading=] with |parameters| and |key|.
-        1.  If |value| is "undefined".
-            1.  Return "undefined".
-        1.  [=map/Set=] |reading|[|key|] to |value|.
+    1.  Let |keys| be the [=/list=] « "`distance`", "`max`" ».
+    1.  [=map/For each=] |keys| of [=/list=]
+        1.  Let |value| be the result of [=parse single-value number reading=] with |parameters| and |keys|.
+            1.  If |value| is **undefined**.
+                1.  Return **undefined**.
+        1.  [=map/Set=] |reading|[|keys|] to |value|[|keys|].
+    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|.
+

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

From 8eb1313cf653d65668c523d4b9e9831356f61e73 Mon Sep 17 00:00:00 2001
From: Juha Vainio 
Date: Wed, 25 Oct 2023 14:43:20 +0300
Subject: [PATCH 3/5] Change list format from map to list

Keys was incorrectly defined as map and not as list.

Defined index for keys which is passed to "parse single-value number reading".

Typo fix in variable.
---
 index.bs | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/index.bs b/index.bs
index d66baf0..d1f5f25 100644
--- a/index.bs
+++ b/index.bs
@@ -217,15 +217,15 @@ The [=per-type virtual sensor metadata=] [=map=] must have the following [=map/e
 
     1.  Let |reading| be a new [=sensor reading=].
     1.  Let |keys| be the [=/list=] « "`distance`", "`max`" ».
-    1.  [=map/For each=] |keys| of [=/list=]
-        1.  Let |value| be the result of [=parse single-value number reading=] with |parameters| and |keys|.
+    1.  [=list/For each=] |key| of |keys|
+        1.  Let |value| be the result of [=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|].
     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.  [=map/Set=] |reading|["near"] to |near|.
     1.  Return |reading|.
 
 

From 0e039e64e6b1746dc5e34e2cf010be713f8a3e98 Mon Sep 17 00:00:00 2001
From: Juha Vainio 
Date: Thu, 26 Oct 2023 08:43:41 +0300
Subject: [PATCH 4/5] Fix style of parameter

Added backticks to "near" when it represents text.
---
 index.bs | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/index.bs b/index.bs
index d1f5f25..9daae3f 100644
--- a/index.bs
+++ b/index.bs
@@ -218,14 +218,14 @@ The [=per-type virtual sensor metadata=] [=map=] must have the following [=map/e
     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 [=parse single-value number reading=] with |parameters| and |key|.
+        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|].
-    1.  Let |near| be the result of invoking [=get a property=] from |parameters| with "near".
+    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.  [=map/Set=] |reading|["`near`"] to |near|.
     1.  Return |reading|.
 
 

From d50353b020aeaa0e927eedea487247e6ecf6e241 Mon Sep 17 00:00:00 2001
From: Juha Vainio 
Date: Thu, 26 Oct 2023 10:46:23 +0300
Subject: [PATCH 5/5] Fix the wrong variable name (keys to key)

---
 index.bs | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/index.bs b/index.bs
index 9daae3f..37f457f 100644
--- a/index.bs
+++ b/index.bs
@@ -221,7 +221,7 @@ The [=per-type virtual sensor metadata=] [=map=] must have the following [=map/e
         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|].
+        1.  [=map/Set=] |reading|[|key|] to |value|[|key|].
     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**.