TWENETstgs - twesettings Library

• 1: printf library
• 2: TWESTG_CMD_u32CmdOp() Command Explanation

1 - printf library

printf-equivalent functions

{{< hint color=“info” >}} The printf library to reference is stored in TWENETmcu/printf. {{< /hint >}}

This TWENETstgs defines fprintf, vfprintf, and sprintf equivalent functions using an open-source printf library.

int TWE_fprintf(TWE_tsFILE *fp, const char *format, ...);
int TWE_vfprintf(TWE_tsFILE *fp, const char *format, va_list va);
#define TWE_snprintf(out,siz,fmt,...) snprintf_(out,siz,fmt,__VA_ARGS__)

Referenced Source Code Description

///////////////////////////////////////////////////////////////////////////////
// \author (c) Marco Paland (info@paland.com)
//             2014-2019, PALANDesign Hannover, Germany
//
// \license The MIT License (MIT)
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
//
// \brief Tiny printf, sprintf and snprintf implementation, optimized for speed on
//        embedded systems with a very limited resources.
//        Use this instead of bloated standard/newlib printf.
//        These routines are thread safe and reentrant.
//
///////////////////////////////////////////////////////////////////////////////

2 - TWESTG_CMD_u32CmdOp() Command Explanation

TWESTG_CMD_u32CmdOp() Command Explanation (for Internal Developers)

Overview

The TWESTG_CMD_u32CmdOp() function in twesettings_cmd.[ch] is intended to execute 0xdb commands. This function includes processes such as obtaining module various information, obtaining configuration information, reflecting configuration information, and resetting. Many processes call the configuration-related helper function TWEINTRCT_cbu32GenericHandler().

Data Types

• TWE_APIRET: Success if the 0x80000000 bit is set, failure if not. The remaining 31 bits are used for parameters.
• TWE_tsBuffer: A structure containing a pointer to the buffer, the sequence length, and the maximum buffer length.
• TWESTG_tsFinal: The management structure for configuration-related settings.

TWESTG_CMD_u32CmdOp()

TWE_APIRET TWESTG_CMD_u32CmdOp(uint8 u8Op, TWE_tsBuffer *pBufIn, TWE_tsBuffer *pBufOut, TWESTG_tsFinal *psFinal)

Performs processing corresponding to u8Op. Input data pBufIn and output data pBufOut are used depending on the process. The last parameter specifies the configuration management structure psFinal.

The u8Op overview is as follows:

E_TWESTG_CMD_OP_ACK = 0xF0                    ACK processing
E_TWESTG_CMD_OP_QUERY_MODULE_INFO = 0xF1    Acquisition of SID, etc.
E_TWESTG_CMD_OP_APPLY_SETTINGS = 0xF2        Apply settings (do not save)
E_TWESTG_CMD_OP_QUERY_SETTINGS = 0xF3        Read settings
E_TWESTG_CMD_OP_MODULE_CONTROL = 0xF8        Various processes related to settings
E_TWESTG_CMD_OP_REVERT = 0xFD               Revert settings
E_TWESTG_CMD_OP_SAVE = 0xFE                 Save settings
E_TWESTG_CMD_OP_DO_MDDULE_RESET = 0xFF,     Module reset

The return value indicates success or failure. Parameters may be set depending on the process.

Processing

E_TWESTG_CMD_OP_ACK (F0)

Performs an ACK response. The input sequence is output as-is.

Example

(None) -> 01       : If no input, 01 is returned.
112233 -> 112233   : If 112233, it is returned as-is in the output.

E_TWESTG_CMD_OP_QUERY_MODULE_INFO (F1)

Retrieves various module information.

E_TWESTG_CMD_OP_APPLY_SETTINGS(F2)

Modifies configuration information.

• Configuration information will not be applied until it is saved and the module is reset.
• The behavior of the application in an unapplied state is undefined.
• If you transition to interactive mode in an undefined state, the changed data will be discarded.
• Even when attempting to change to the same content as existing data, this process returns a successful return value. However, if a save (E_TWESTG_CMD_OP_SAVE) is executed, no actual save will occur.
• This process does not write to the output (pBufOut).

Configuration Data

Example

01011234BEEF        Sets Application ID (0x01) to 0x1234BEEF.
010212              Sets Channel (0x02) to 0x12 (18).

E_TWESTG_CMD_OP_QUERY_SETTINGS(F3)

Retrieves configuration information.

Output for QTYP==1

Example

0101 -> 051234BEEF  -> Application ID (uint32_t 0x1234beef)
0102 -> 010D        -> Channel (uint8_t 13)

E_TWESTG_CMD_OP_REVERT (0xFD)

By executing E_TWESTG_CMD_OP_SAVE immediately after this command, the configuration information is reverted to its initial values.

• Calls TWEINTRCT_cbu32GenericHandler(psIntr, E_TWEINRCT_OP_REVERT, TRUE, 0, NULL). The TRUE specified in the third argument means that the saved configuration information is not loaded. Ensure that the application’s TWEINTRCT_cbu32GenericHandler() is correctly implemented.

No input data, no output data.

E_TWESTG_CMD_OP_SAVE (0xFE)

When configuration information is changed, it is saved to non-volatile memory.

• If attempting to overwrite or change to the same values that are already set, no save is performed. The function returns TWE_APIRET_SUCCESS_W_VALUE(0x100 | E_TWESTG_CMD_OP_SAVE).
• If a save is performed, a reset should be carried out promptly (operation with changed settings without reset is undefined).

No input data, no output data.

E_TWESTG_CMD_OP_DO_MDDULE_RESET (0xFF)

Resets the module.

No input data, no output data.