Skip to content

Commit

Permalink
Adding new docu
Browse files Browse the repository at this point in the history
  • Loading branch information
FranciscoLlobet committed Mar 2, 2024
1 parent ff7b032 commit c7be09a
Show file tree
Hide file tree
Showing 6 changed files with 56 additions and 2 deletions.
20 changes: 19 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,25 @@ The current version of `MISO` boasts a set of features, including:
- HW Watchdog (7s idle timeout)
- Bootloader with support for MCUBoot firmware containers

Either a binary with LwM2M via secure COAP (DTLS) or MQTT via TLS.
Either a binary with LwM2M via secure COAP (DTLS) or MQTT via TLS can be loaded at a time.

## Main bugs

- The LwM2M client will do a watchdog reset after approximately 7 minutes.
- The current architecture is dependent on FreeRTOS.
- Current no entropy is being queried when starting MbedTLS functionality.

## Wish List

- Implementation of SimpleLink File Storage
- Stability improvements of the LwM2M client
- Stability improvments of the connection manager
- Memory optimization of statically allocated memory.
- Improvements on documentation.
- Programming via openOCD
- Programming scripts via console
- HTTP deployment script for FW update
- MQTT FW update

## Non-Features

Expand Down
15 changes: 15 additions & 0 deletions csrc/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# C-Source

A folder which contains the libraries in C-Language

- [board](./board/). The Board Support Package.
- [config](./config/). Configuration and customization options used by the C-Libraries.
- [connectivity](./connectivity/). Libraries which contain code that supports connectivity.
- [crypto/mbedtls](./crypto/mbedtls). Crypto and TLS library
- [inc](./inc/). Internal Interfaces.
- [mcuboot](./mcuboot/). Mcuboot, a Firware update library.
- [sensors](./sensors/). Libraries with sensor drivers
- [src](./src/). Internal C-code for miso.
- [utils](./utils/). Utilitity
- [jsmn](./utils/jsmn/). A JSON parsing utility.
- [system](./system/). System Libraries.
3 changes: 3 additions & 0 deletions csrc/board/inc/board_cc3100.h
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@
*
* Created on: 11 nov 2022
* Author: Francisco
*
* Board support component for the CC3100 Wifi module
*
*/

#ifndef BOARD_CC3100_H_
Expand Down
8 changes: 8 additions & 0 deletions csrc/board/src/board.c
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,14 @@
*
* Created on: 8 nov 2022
* Author: Francisco
*
* Board driver for the XDK110
*
* Includes support for:
* - Picolibc toolchain
* - FreeRTOS
* - Bootloader
*
*/

#include "board.h"
Expand Down
2 changes: 1 addition & 1 deletion csrc/board/src/sdmm.c
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
MODIFICATIONS:
UISO, 2022-2023
MISO, 2022-2024
Modifications to add simplified logic to interface with the board
Expand Down
10 changes: 10 additions & 0 deletions csrc/system/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# csrc/system

C-Source of system components

This folder contains the submodules of following components

- [FreeRTOS-Kernel](./FreeRTOS-Kernel/). A Submodule of the FreeRTOS OS Kernel.
- [cc3100-sdk](./cc3100-sdk/). A copy of the TI CC3100 .SimpleLink SDK.
- [ff15](./ff15/). A copy of the FatFS v15 File system driver.
- [gecko_sdk](./gecko_sdk/). A submodule of the EFM32 Gecko SDK.

0 comments on commit c7be09a

Please sign in to comment.