Browse Source

Added I2C example and further compatibility modules listed

Cefn Hoile 1 year ago
parent
commit
a75b48ca9e
2 changed files with 21 additions and 9 deletions
  1. 8
    9
      README.rst
  2. 13
    0
      examples/index.md

+ 8
- 9
README.rst View File

@@ -19,6 +19,9 @@ on hosts running micropython. Working code exists to emulate the CircuitPython p
19 19
 * **board** - breakout-specific pin identities
20 20
 * **microcontroller** - chip-specific pin identities
21 21
 * **digitalio** - digital input/output pins, using pin identities from board+microcontroller packages
22
+* **bitbangio** - software-driven interfaces for I2C, SPI
23
+* **busio** - hardware-driven interfaces for I2C, SPI, UART
24
+* **time** * - substitute functions monkey-patched to time module
22 25
 
23 26
 
24 27
 Dependencies
@@ -28,25 +31,21 @@ The Micropython compatibility layers described above are intended to provide a C
28 31
 are running Micropython. Since corresponding packages should be built-in to any standard
29 32
 CircuitPython image, they have no value on a device already running CircuitPython and would likely conflict in unhappy ways.
30 33
 
31
-The test suites under **testing.implementation.all** are by design
34
+The test suites in the test/src folder under **testing.universal** are by design
32 35
 intended to run on *either* CircuitPython *or* Micropython+compatibility layer to prove conformance. 
33 36
 
34
-The test suites under **testing.implementation.micropython** will only run
35
-on Micropython and **testing.implementation.circuitpython** will only run on CircuitPython
36
-
37
-
38 37
 Usage Example
39 38
 =============
40 39
 
41
-At the time of writing (`git:b70fd42a <https://github.com/cefn/Adafruit_Micropython_Blinka/tree/b70fd42adf2b81c7f8b176decc0bec4fb93abfe9>`_),
40
+At the time of writing (`git:7fc1f8ab <https://github.com/cefn/Adafruit_Micropython_Blinka/tree/7fc1f8ab477124628a5afebbf6826005955805f9>`_),
42 41
 the following sequence runs through some basic testing of the digitalio compatibility layer... 
43 42
 
44 43
 .. code-block:: python
45 44
 
46
-    import testing
47
-    testing.main()
45
+    from testing import test_module_name
46
+    test_module_name("testing.universal.digitalio")
48 47
 
49
-A typical log from running the suites is `here <https://github.com/cefn/Adafruit_Micropython_Blinka/issues/2#issuecomment-366713394>`_ .
48
+An example log from running the suites is `here <https://github.com/cefn/Adafruit_Micropython_Blinka/issues/2#issuecomment-366713394>`_ .
50 49
 
51 50
 
52 51
 Contributing

+ 13
- 0
examples/index.md View File

@@ -37,6 +37,19 @@ from testing import test_module_name
37 37
 test_module_name("testing.universal.digitalio")
38 38
 ```
39 39
 
40
+Or to take a more involved example of constructing a test suite requiring hardware, 
41
+the following should verify I2C communication with a BME280 module.
42
+
43
+```python
44
+import unittest
45
+import testing.universal.i2c
46
+suite = unittest.TestSuite()
47
+suite.addTest(testing.universal.i2c.TestBME280Interactive)
48
+runner = unittest.TestRunner()
49
+runner.run(suite)
50
+```
51
+
52
+
40 53
 To prove this on a newly-flashed Feather Huzzah running Micropython 1.9.3, 
41 54
 it should be possible (on a posix-compliant platform with adafruit_ampy installed) 
42 55
 to `cd test/scripts` then run `./upload_feather_huzzah_micropython_put.sh` to 

Loading…
Cancel
Save