From 58fdd92e73948955f6b19c7f005fae1a9564ac65 Mon Sep 17 00:00:00 2001 From: Paul Sokolovsky Date: Tue, 3 Nov 2015 18:57:35 +0200 Subject: [PATCH] Add terminology section, short so far. --- Hardware-API.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/Hardware-API.md b/Hardware-API.md index c4b3d75..22ef691 100644 --- a/Hardware-API.md +++ b/Hardware-API.md @@ -9,6 +9,11 @@ The API should be Pythonic, obvious and relatively minimal. There should be a c The existing pyb module already provides such abstraction but it is not as clean or consistent or general as it could be. The new hardware API will co-exist alongside the pyb module (only for stmhal port, eg pyboard) so that existing scripts still run. The pyb module will eventually be deprecated, but only after all functionality finds another home (which may be some time). +# Terminology + +* Port - when used in this document, refers to some kind of hardware port. +* Software - MicroPython ported to a particular CPU/MCU/SoC. A separate word used to disambiguate word "port" (which otherwise may refer to a hardware or software port) + # Use cases Create a UART with various pin configurations: