Libraries, Apps, etc.

Explanation of TWENET Libraries and Apps

We will provide an explanation of TWENET libraries and apps, focusing on the topic of TWELITE GOLD.

Libraries, Apps, etc.

In TWELITE GOLD, we have prepared libraries that behave relatively similarly to the development code of TWELITE BLUE/RED.

In TWELITE BLUE/RED, the utils and TWENET C API, as well as the MWX library, are built on the AHI API and AppAPI supplied by the semiconductor manufacturer.

[TWENET C++ API/MWX           ] setup(), loop() style API on C++
[utils][TWENET C API          ] lagacy C library
[AHI API          ][AppAPI    ]
--------------------------------
[MCU PERIPHERAL   ][MAC LAYER] HARDWARE

In TWELITE GOLD, the library provided by the semiconductor manufacturer is the FSL library, and its compatibility with TWELITE BLUE/RED is very limited. In order to run the code already implemented by our company with relatively minor modifications, we have created the TWENETcmpt library. TWENETcmpt minimizes direct calls to the FSL library and is implemented using the TWENETmwf library, which abstracts peripheral procedures.

[TWENET C++ API/MWX                         ]
[TWENET C API                               ]
[TWENETutils]
     [TWENETcmpt - AHI          ]
     [TWENETmwf C++ LIB         ]
                              [App API  ]
[FSL LIBRARY                   ][MiniMac  ]
---------------------------------------------
[MCU PERIPHERAL                ][MAC LAYER]

TWENETmwf - A C++ library that aggregates FSL library procedures.
TWENETcmpt - A group of AHI-compatible functions implemented using the TWENETmwf library.
TWENETutils - Equivalent to utils in BLUE/RED. Some parts, such as UART, are implemented directly by the FSL library.
MiniMac and AppAPI - Libraries provided by the semiconductor manufacturer with undisclosed source code. The direct API for handling the MCU semiconductor’s MAC layer is a library named MiniMac, and an AppAPI-compatible API is provided using MiniMac.
FSL Library - A library provided by the semiconductor manufacturer with disclosed source code. It mainly contains procedures for handling peripherals.

TWENET Library List

Name	Explanation
TWENETmwx	A C++ library for writing in a `setup()`/`loop()` style.
TWENETeastl	The EASTL library. (A C++ template library for containers, iterators, and algorithms, intended to be used with Act code.)
TWENETstgs	A C library mainly for managing settings.
TWENETcmpt	An intermediate library for porting source code that uses the AHI library, which is used for writing for TWELITE BLUE/RED. (Uses TWENETmwf)
TWENETmwf	A C++ library that aggregates necessary functions from the FSL library for handling microcontroller peripherals.
TWENETcore	The core TWENET library (source is not included).
TWENEText	The core TWENET library 2 (source is not included).
TWENETutils	A base library for peripherals, etc. Includes a group of `serial` and `uart` functions for UART support.
TWENETmcu	Contains `main()` and microcontroller/peripheral library functions, etc.

TWELITE Apps, Samples

We are building projects for TWELITE Apps. If there are any restrictions on the behavior specific to TWELITE GOLD, they will be listed in the LIMITATIONS section of the README.md file located directly under the project directory. The LIMITATIONS include hardware limitations and those that we do not plan to address.

Required Libraries: TWENETmcu, TWENETutils, TWENETcore, TWENEText, TWENETmwf, TWENETcmpt
Libraries used in some cases: TWENETstgs

Act_samples, Act_extras

If there are any restrictions on the operation specific to TWELITE GOLD for sample code using Act, they will be listed in the LIMITATIONS section of the README.md file located directly under the project directory. The LIMITATIONS include hardware limitations and those that we do not plan to address.

Required Libraries: TWENETmcu, TWENETutils, TWENETcore, TWENEText, TWENETmwf, TWENETcmpt, TWENETstgs, TWENETmwx
The build definitions for EASTL are included in Act_Unit_EASTL and Act_Template. Other samples do not have include paths or library specifications.

Regarding the MCUXpresso Workspace

The libraries mentioned above are stored directly under the current folder in the MWSDK installation directory (.../MWSTAGE/MWSDK).

In MCUXpresso, select File > Import..., then in the dialog box that appears, select General > Existing Projects into Workspace and press the Next button. In the next dialog, specify the current folder, and all the TWENET??? libraries listed above will be displayed, so add all of them.

Creating a new project

A new project is created by importing an existing project in MCUXpresso and then changing its name.

Project	Copy source	Remarks
C language and using AHI-compatible library<br />`App_Twelite`, `App_Wings`, etc.	`App_Twelite`	C++ source code can also be added, but may require changes to definitions, etc.
Act	`Act_MYPROJ_template.zip`	`setup()` and `loop()` style code. C++ is assumed. A project archive is available. <br />The archive can also be imported from `General > Existing Projects into Workspace`.

Here is an example of the steps to create a new project based on an already imported project:

Back up the existing project or create an archive from the Export menu.
Rename the existing project.
Re-import the project you backed up in step 1.