[I2C] Adding the doc file #209
Conversation
| unsigned long size, | ||
| optional octet register, | ||
| optional repetitions = 1); | ||
| write(octet device, (USVString or sequence<octet>) data); |
There was a problem hiding this comment.
Apologies since this is nice, but the intent of these docs is to exactly match the actual existing functionality available today. So if I'm correct in assuming this is the goal rather than the present state, please save a copy of this somewhere but remove the things that aren't actually implemented.
I don't know what a USVString is, but if we're just accepting a Jerry string I'd just call this 'string' and probably for sequence it should be Buffer, if that's indeed supported?
There was a problem hiding this comment.
Fair enough, ill update it to only include what currently works
| optional repetitions = 1); | ||
| write(octet device, (USVString or sequence<octet>) data); | ||
| writeBit(octet device, boolean data); | ||
| void abort(); // abort all current read / write operations |
There was a problem hiding this comment.
Does it really abort the operation? or this is just like aborting the promises like the Soletta api did? Because all your api is synchrounous
There was a problem hiding this comment.
I hadn't implemented either yet so I took them out until I know what they will do. Or if they will even do anything, which likely they wont since as you said its synchronous.
|
|
||
| ### I2CBus.abort | ||
|
|
||
| `void abort();` |
|
|
||
| dictionary I2CInit { | ||
| octet bus; | ||
| I2CBusSpeed speed; |
There was a problem hiding this comment.
these should be 4-space indented like above
|
|
||
| [NoInterfaceObject] | ||
| interface I2CBus { | ||
| // has all the properties of I2CInit as read-only attributes |
| [NoInterfaceObject] | ||
| interface I2CBus { | ||
| // has all the properties of I2CInit as read-only attributes | ||
| write(octet device, (string or sequence<octet>) data); |
There was a problem hiding this comment.
From IRC, sounds like data is just Buffer, not a choice of types.
Adding the documentation for the I2C API
Adding the documentation for the I2C API