Sensors API

[ericpearson]

This implements the sensors on the BB10 device, all currently present sensors are supported.

Issue #301

Docs are here:
blackberry-webworks/WebWorks-API-Docs/pull/218

[nukulb]

perhaps we can do some work on the interface

I do know this exists
http://dvcs.w3.org/hg/dap/raw-file/tip/sensor-api/Overview.html#datatypes

@Pagey - can you check if any of this is supported by webkit? my guess is its not.

[nukulb]

any reason to remove all of these

[nukulb]

@jeffheifetz @kwallis - need input on this-
Some open questions are -

1. since there is a spec around Sensors API, should we meeting that spec or designing close to that spec.
   I think we should but the spec seems very limited.
   http://dvcs.w3.org/hg/dap/raw-file/tip/sensor-api/Overview.html
   @jeffheifetz any suggestions on how to retro fit our sensors to be closer to the spec.
2. Accelerometer and device orientation are already supported by webkit, should we expose these through the interface or not?

[kwallis]

1. We had talked about doing investigation on what already exists out there in specs before we implemented, did that not happen? For instance, looking at the link you sent, it indicated it was put on hold as they pulled specific sensor APIs out into their own specs. Looking at http://www.w3.org/2009/dap/, there are specs for proximity, ambient light, temperature, humidity, and pressure.
2. If the browser supports the API already, this should be a pure documentation task, and not exposed in a separate WebWorks API

[nukulb]

They are really same spec just with different names For eg.
interface DeviceProximityEvent : Event {
readonly attribute double value;
readonly attribute double min;
readonly attribute double max;
};

interface AmbientTemperatureEvent : Event {
readonly attribute double f;
readonly attribute double c;
readonly attribute double k;
};

Some have one value and other have more than 1.

So can we define the interfaces now for each of the sensors, seems like

You can look at the file below to see what all sensors are possible and what they return.
4181e1d#L10R163

Question is whether you want to ployfill like the Notifications APIs or do you want to provide all the APIs under
blackberry.addEventListener.

It really doesn't matter much to me but a decision needs to be made.

I think for the ones that defined we can simply meet the spec definition.

There are APIs where we return more than the spec in that case we can append to it.

[nukulb]

updated the above comment to put proper link in there.

[kwallis]

I would like to meet the spec definitions if we can, and extend where we have additional features/requirements

[nukulb]

temperature, humidity,altimeter and pressure are not supported

4181e1d#L10R234

So the only overlap is proximity, ambient light, but we should have similar interfaces for all the sensors to make sure it doesn't go

[kwallis]

We have temperature, humidity, and altimeter listed as available in the original user story, with links to the PPS objects:
blackberry#301
So I am not sure what you mean by they are not supported?

[nukulb]

updated

[ericpearson]

I agree now that looking the w3c spec it should be better to align ourselves with it, when I originally designed this I wasn't aware of any of the events other than the devicemotion and deviceorientation events. I guess for holster we can have a deviceholstered event listener. I still find the w3c very cryptic to understand what exactly is supported and how to get the data you actually want.

[ericpearson]

This is done refactoring and waiting for testing/code review, docs are forthcoming

[ericpearson]

Docs are updated, please test and code review

[ericpearson]

@rwmtse can I get a code review for this when you get a chance? @tracyli please test :)

[rwmtse]

Does this ever get deleted?

[ericpearson]

nice catch, I will fix it

[ericpearson]

now handled by destructor, should free everything now

[rwmtse]

r+

[tracyli]

tested with packager build http://ci0000003863287:8080/hudson/job/BB10-Webworks-Packager/99/ and framework build http://ci0000003863287:8080/hudson/job/BB10-Webworks-Framework-next-sensors/34/: sensor events work as expected.
However, there's an observation:
1.automated function test widget for sensor got failed when run it at the first time; but when re-running the widget, it got passed.

[nukulb]

@tracyli has this been tested on the simulator?

[tracyli]

not yet; as I said yesterday the simulator 1035 shows up as black screen for me and I'll try again.

[ericpearson]

this is impossible to test on the simulator

[nukulb]

@Pagey why?

[ericpearson]

there is no way to compile for it as there isn't a library for sensors, plus the simulator has no way of emulating them