Added I2C example and further compatibility modules listed

diff --git a/README.rst b/README.rst
index 993e0a9c976f36b58ba2e5cb71426ccfa4715b86..127131d434ec12a81a2c83b3c4dd97d0a160b003 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -19,6 +19,9 @@ on hosts running micropython. Working code exists to emulate the CircuitPython p
 * **board** - breakout-specific pin identities
 * **microcontroller** - chip-specific pin identities
 * **digitalio** - digital input/output pins, using pin identities from board+microcontroller packages
 * **board** - breakout-specific pin identities
 * **microcontroller** - chip-specific pin identities
 * **digitalio** - digital input/output pins, using pin identities from board+microcontroller packages

+* **bitbangio** - software-driven interfaces for I2C, SPI
+* **busio** - hardware-driven interfaces for I2C, SPI, UART
+* **time** * - substitute functions monkey-patched to time module

 
 
 Dependencies
 
 
 Dependencies


@@ -28,25 +31,21 @@ The Micropython compatibility layers described above are intended to provide a C
 are running Micropython. Since corresponding packages should be built-in to any standard
 CircuitPython image, they have no value on a device already running CircuitPython and would likely conflict in unhappy ways.
 
 are running Micropython. Since corresponding packages should be built-in to any standard
 CircuitPython image, they have no value on a device already running CircuitPython and would likely conflict in unhappy ways.
 

-The test suites under **testing.implementation.all** are by design
+The test suites in the test/src folder under **testing.universal** are by design

 intended to run on *either* CircuitPython *or* Micropython+compatibility layer to prove conformance. 
 
 intended to run on *either* CircuitPython *or* Micropython+compatibility layer to prove conformance. 
 

-The test suites under **testing.implementation.micropython** will only run
-on Micropython and **testing.implementation.circuitpython** will only run on CircuitPython
-
-

 Usage Example
 =============
 
 Usage Example
 =============
 

-At the time of writing (`git:b70fd42a <https://github.com/cefn/Adafruit_Micropython_Blinka/tree/b70fd42adf2b81c7f8b176decc0bec4fb93abfe9>`_),
+At the time of writing (`git:7fc1f8ab <https://github.com/cefn/Adafruit_Micropython_Blinka/tree/7fc1f8ab477124628a5afebbf6826005955805f9>`_),

 the following sequence runs through some basic testing of the digitalio compatibility layer... 
 
 .. code-block:: python
 
 the following sequence runs through some basic testing of the digitalio compatibility layer... 
 
 .. code-block:: python
 

-    import testing
-    testing.main()
+    from testing import test_module_name
+    test_module_name("testing.universal.digitalio")

 
 

-A typical log from running the suites is `here <https://github.com/cefn/Adafruit_Micropython_Blinka/issues/2#issuecomment-366713394>`_ .
+An example log from running the suites is `here <https://github.com/cefn/Adafruit_Micropython_Blinka/issues/2#issuecomment-366713394>`_ .

 
 
 Contributing
 
 
 Contributing

diff --git a/examples/index.md b/examples/index.md
index 0a03af33a8906d99b4b4740cad90da9a1d926fb1..184ca33b76e3e04a656d99064a8407f97dcca0f8 100644 (file)
--- a/examples/index.md
+++ b/examples/index.md
@@ -37,6 +37,19 @@ from testing import test_module_name
 test_module_name("testing.universal.digitalio")
 ```
 
 test_module_name("testing.universal.digitalio")
 ```
 

+Or to take a more involved example of constructing a test suite requiring hardware, 
+the following should verify I2C communication with a BME280 module.
+
+```python
+import unittest
+import testing.universal.i2c
+suite = unittest.TestSuite()
+suite.addTest(testing.universal.i2c.TestBME280Interactive)
+runner = unittest.TestRunner()
+runner.run(suite)
+```
+
+

 To prove this on a newly-flashed Feather Huzzah running Micropython 1.9.3, 
 it should be possible (on a posix-compliant platform with adafruit_ampy installed) 
 to `cd test/scripts` then run `./upload_feather_huzzah_micropython_put.sh` to 
 To prove this on a newly-flashed Feather Huzzah running Micropython 1.9.3, 
 it should be possible (on a posix-compliant platform with adafruit_ampy installed) 
 to `cd test/scripts` then run `./upload_feather_huzzah_micropython_put.sh` to