Procházet zdrojové kódy

docs: renamed list to known limitations

Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
Mihai Tudor Panu před 9 roky
rodič
revize
597b2a6f70
2 změnil soubory, kde provedl 14 přidání a 13 odebrání
  1. 1
    1
      README.md
  2. 13
    12
      docs/knownlimitations.md

+ 1
- 1
README.md Zobrazit soubor

@@ -64,4 +64,4 @@ The C/C++ documentation is available [here](http://iotdk.intel.com/docs/master/u
64 64
 
65 65
 Version @ref changelog [here](docs/changelog.md).
66 66
 
67
-List of @ref knownissues [here](docs/knownissues.md).
67
+List of @ref knownlimitations [here](docs/knownlimitations.md).

docs/knownissues.md → docs/knownlimitations.md Zobrazit soubor

@@ -1,10 +1,9 @@
1
-Known Issues                        {#knownissues}
1
+Known Limitations                       {#knownlimitations}
2 2
 ===============
3 3
 
4
-Every once in a while we come across sensors that will not pair well with
5
-a specific board. This means their are either incompatible or will work only
6
-under specific settings. This is a list of such sensors and known workarounds
7
-if they exist.
4
+Some sensors do not work seamlessly with a specific board. This means that they
5
+are either incompatible or work only under specific settings. This is a list of
6
+such sensors and known workarounds if they exist.
8 7
 
9 8
 #### Grove Sensors
10 9
 
@@ -35,16 +34,18 @@ if they exist.
35 34
 
36 35
 #### Adafruit Sensors
37 36
 
38
- * **Adafruit Motor Shield** (1438) will not get detected on the I2C bus when
37
+ * **Adafruit Motor Shield** (1438) is not detected on the I2C bus when
39 38
  connected to the Intel Edison with an Arduino breakout.
40 39
 
41 40
 #### Other Sensors
42 41
 
43 42
  * **MPU9150** might return inaccurate data.
44 43
 
45
-Some I2C sensors seem to add too much capacitance to the SDA line of the Intel
46
-Edison Arduino breakout board, thus the signal essentially becomes stuck to a
47
-logic 1. When this happens, any other sensors connected to the I2C bus will be
48
-rendered useless too. There is no universal solution for this issue, but under
49
-most cases the same sensor will work just fine on the Intel Edison Mini. Using
50
-the same sensor but from a different vendor can also work in some cases.
44
+#### General
45
+
46
+Some I2C sensors add too much capacitance to the SDA line of the Intel Edison
47
+Arduino breakout board, thus the signal sticks to a logic 1. When this happens,
48
+other sensors connected to the I2C bus are unusable. While there is no generic
49
+solution for this limitation, in most cases the sensor works on the Intel
50
+Edison Mini-breakout. When this board is not an option, the sensor can be
51
+sometimes replaced with the same model from a different vendor.