added sensor JSON docs

Signed-off-by: Budanov <daniil.budanov@intel.com>
Signed-off-by: Abhishek Malik <abhishek.malik@intel.com>
This commit is contained in:
Budanov
2017-06-30 12:50:33 -07:00
committed by Abhishek Malik
parent 4344151405
commit f01c89b95a
5 changed files with 368 additions and 0 deletions

View File

@ -0,0 +1,46 @@
{
"Library": "wheelencoder",
"Description": "Wheel Encoder Library",
"Sensor Class":
{
"WheelEncoder":
{
"Brief": "Wheel Encoder",
"Description": "Wheel encoders use non-contact methods to give rotation information. This sensor was developed for the DFRobot Wheel Encoder, though it could be used for any counting time-based task. When you instantiate a class of this type, the gpio pin specified is connected to an interrupt. Whenever a low to high transition occurs on the gpio pin, the internal counter is incremented by one. This class also includes a millisecond counter, so that you can correlate the number of counts to a time period for calculating an RPM or other value as needed.",
"Known As": ["Wheel Encoder"],
"Categories": ["other"],
"Connections": ["gpio"],
"Project Type": ["prototyping"],
"Manufacturers": ["dfrobot"],
"Kits": ["DFRobot 3PA", "DFRobot 4WD"],
"Image": "wheelencoder.jpg",
"Examples":
{
"Python": ["wheelencoder.py"],
"Node.js": ["wheelencoder.js"],
"C++": ["wheelencoder.cxx"],
"C": ["wheelencoder.c"]
},
"Specifications":
{
"Vdd": {"unit": "v", "constant" : 5},
"Itotal" : {"unit": "mA", "high": 20},
"Resolution": {"unit": "ppr", "constant" : 20}
},
"Platforms":
{
"Intel Joule Module":
{
"Notes": [""],
"Images": [""]
}
},
"Urls" :
{
"Product Pages": ["https://www.dfrobot.com/product-98.html"],
"Datasheets": ["https://www.dfrobot.com/wiki/index.php/Wheel_Encoders_for_DFRobot_3PA_and_4WD_Rovers_(SKU:SEN0038)"],
"Schematics": ["http://www.dfrobot.com/wiki/images/b/b9/FIT0029_Encoder_Schematics.png"]
}
}
}
}