Updating README file
authorNathael Pajani <nathael.pajani@ed3l.fr>
Thu, 3 Nov 2022 00:07:00 +0000 (01:07 +0100)
committerNathael Pajani <nathael.pajani@ed3l.fr>
Tue, 8 Nov 2022 16:03:05 +0000 (17:03 +0100)
README

diff --git a/README b/README
index 8ad8dc4..c234b64 100644 (file)
--- a/README
+++ b/README
@@ -5,10 +5,10 @@ Good programmers write code that humans can understand.
 This repository provides support for the LPC122x microcontroller from NXP and
 example code for the development modules made by Techno-Innov.
 
-It has support for the LPC122x as used on the development modules, and
-for the peripherals found on the development modules (user led, eeprom,
-temperature sensor, CC1101 RF transceiver, ...).
-Support for various other cool stuff is added when we play with it.
+It has support for the LPC122x as used on the development modules made by
+Techno-Innov, and for the peripherals found on the development modules (user
+led, eeprom, temperature sensor, CC1101 RF transceiver, ...).
+Support for various other cool stuff is added when we need it.
 
 Example applications are created in the apps/[module name] directories for
 each module, with one sub-directory for each application. These are (and must
@@ -24,7 +24,7 @@ an example from apps/[module name]/ to the name you want and start coding.
 BUID and FLASH
 
 Build has been tested using gcc, and only gcc, in the version provided by
-Debian GNU/Linux distribution, and a few other binary versions available for
+Devuan GNU/Linux distribution, and a few other binary versions available for
 download on the Internet, but any ARM gcc toolchain should do.
 
 In order to get the debian ARM gcc cross-toolchain you should install the
@@ -39,14 +39,16 @@ simple "make" command in the base directory, which will build all apps, or
 run "make <module_name>/<app_name>" to build a specific application.
 You can also run the simple "make" command in the specific app subdirectory
 to compile this application alone.
+The build includes all C files from the app directory, and the resulting binary
+gets the app name (directory name).
 The provided Makefiles display some information about the size and memory
 usage of the generated binary.
 
-To flash the binary (the one with .bin) to the LPC Flash you will need the
-lpctool package, now packaged for Debian, starting with Jessie, or available
-in our git repository : http://git.techno-innov.fr/lpctools (Clone using :
-git clone http://gitclone.techno-innov.fr/lpctools and then build (make) and
-use :)
+To flash the binary (the file ending with ".bin") to the embedded LPC Flash you
+will need the lpctool package, now packaged for Debian (starting with Jessie),
+or available in our git repository : http://git.techno-innov.fr/lpctools (Clone
+using : git clone http://gitclone.techno-innov.fr/lpctools and then build
+(make) and use :)
 Usual command lines :
    lpcprog -d /dev/ttyUSB0 -c id
    lpcprog -d /dev/ttyUSB0 -c flash app_name.bin
@@ -112,18 +114,25 @@ SUPPORTED FEATURES and INTERFACES
    - Maxim Max31855 thermocouple to digital converters
    - On semiconductor NCN5120 KNX bus interface (under test)
    - VEML6070 I²C UV sensor
+   - TSL256x ambiant and IR light sensor (obsolete)
+   - BME280 triple sensor (temperature, pressure and humidity)
+   - BQ769x0 multi-cell BMS (Battery management)
+   - PCF85363 RTC
+   - SD/MMC cards
+   - SSD130x Oled displays
+   - ST7735 TFT displays
 
 - Other
+   - CRC-CITT
    - 8x8 font for use with Epaper display
    - DTPlug (or any host) communication protocol
+   - MQTT communication protocol
 
 
 ********************
 TODO :
 
-- Deep sleep mode support.
 - Test all the GPIO in different modes
-- Add support for SDCard over SPI
 - Complete RTC Support
 - Comparator support
 - CRC engine support