fix Variables test cases

Author: Matthias Akstaller

CMakeLists.txt

@@ -146,7 +146,7 @@ set(MO_SRC_UNIT
     #tests/Reservation.cpp
     #tests/Reset.cpp
     #tests/LocalAuthList.cpp
-    #tests/Variables.cpp
+    tests/Variables.cpp
     #tests/Transactions.cpp
     #tests/Certificates.cpp
     #tests/FirmwareManagement.cpp

src/MicroOcpp.h

@@ -32,7 +32,7 @@ extern "C" {
 //call mo_setup() to finalize the setup
 bool mo_initialize();
 
-//End the lifecycle of MO and free all resources
+//End the lifecycle of MO and free all resources. Can be called any time
 void mo_deinitialize();
 
 //Returns if library is initialized
@@ -42,7 +42,8 @@ bool mo_isInitialized();
 MO_Context *mo_getApiContext();
 
 #if MO_USE_FILEAPI != MO_CUSTOM_FS
-//Set if MO can use the filesystem and if it needs to mount it. See "FilesystemAdapter.h" for all options
+//Set if MO can use the filesystem and if it needs to mount it. See "FilesystemAdapter.h" for all
+//options. Can only set before `mo_setup()`.
 void mo_setFilesystemConfig(MO_FilesystemOpt opt);
 void mo_setFilesystemConfig2(MO_Context *ctx, MO_FilesystemOpt opt, const char *pathPrefix);
 #endif //#if MO_USE_FILEAPI != MO_CUSTOM_FS
@@ -58,6 +59,8 @@ void mo_setFilesystem2(MO_Context *ctx, MO_FilesystemAdapter *filesystem);
  * If the connections fails, please refer to
  * https://github.com/matth-x/MicroOcpp/issues/36#issuecomment-989716573 for recommendations on
  * how to track down the issue with the connection.
+ * 
+ * Can only set before `mo_setup()`.
  */
 bool mo_setWebsocketUrl(
         const char *backendUrl,       //e.g. "wss://example.com:8443/steve/websocket/CentralSystemService". Must be defined
@@ -96,6 +99,8 @@ bool mo_setWebsocketUrl(
  * 
  * Note: MO v2 does not reset the `Context` pointer in the C++ `Connection` anymore during
  * `mo_deinitialize()`. It's recommended to check `ctx` in `MO_Connection`, or `mo_getContext()`.
+ * 
+ * Can only set before `mo_setup()`.
  */
 void mo_setConnection(MO_Connection *connection);
 void mo_setConnection2(MO_Context *ctx, MO_Connection *connection);
@@ -124,12 +129,12 @@ void mo_useMockServer();
 #endif //MO_ENABLE_MOCK_SERVER
 
 //Set the OCPP version `MO_OCPP_V16` or `MO_OCPP_V201`. Works only if build flags `MO_ENABLE_V16` or
-//`MO_ENABLE_V201` are set to 1
+//`MO_ENABLE_V201` are set to 1. Can only set before `mo_setup()`.
 void mo_setOcppVersion(int ocppVersion);
 void mo_setOcppVersion2(MO_Context *ctx, int ocppVersion);
 
 //Set BootNotification fields (for more options, use `mo_setBootNotificationData2()`). For a description of
-//the fields, refer to OCPP 1.6 or 2.0.1 specification
+//the fields, refer to OCPP 1.6 or 2.0.1 specification. Can only set before `mo_setup()`.
 bool mo_setBootNotificationData(
         const char *chargePointModel,   //model name of this charger, e.g. "Demo Charger"
         const char *chargePointVendor); //brand name, e.g. "My Company Ltd."
@@ -161,7 +166,7 @@ bool mo_setBootNotificationData2(MO_Context *ctx, MO_BootNotificationData bnData
  *     });
  * ```
  *
- * Configure the library with Inputs and Outputs after mo_initialize() and before mo_setup().
+ * Configure the library with Inputs and Outputs after mo_initialize() and before `mo_setup()`.
  */
 
 void mo_setConnectorPluggedInput(bool (*connectorPlugged)()); //Input about if an EV is plugged to this EVSE
@@ -219,6 +224,8 @@ void mo_loop();
  *
  * Returns true if it was possible to create the transaction process. Returns
  * false if either another transaction process is still active or you need to try it again later.
+ * 
+ * Transaction management functions can only be called after `mo_setup()`.
  *
  * OCPP 2.0.1:
  * Authorize a transaction. Like the OCPP 1.6 behavior, this should be called when the user swipes the
@@ -437,7 +444,8 @@ void mo_setOnUnlockConnector2(MO_Context *ctx, unsigned int evseId, MO_UnlockCon
 
 
 /*
- * Access further information about the internal state of the library
+ * Access further information about the internal state of the library. Can only be called
+ * after `mo_setup()`.
  */
 
 bool mo_isOperative(); //if the charge point is operative (see OCPP1.6 Edit2, p. 45) and ready for transactions
@@ -490,7 +498,7 @@ void mo_v201_setOnResetExecute2(MO_Context *ctx, unsigned int evseId, bool (*onR
 #endif //MO_ENABLE_V201
 
 /*
- * Further platform configurations (Advanced)
+ * Further platform configurations (Advanced). Can only set before `mo_setup()`.
  */
 
 //Set custom debug function
@@ -551,7 +559,7 @@ void mo_setDiagnosticsFtpServerCert(MO_Context *ctx, const char *cert); //zero-c
 #endif //MO_ENABLE_MBEDTLS
 
 /*
- * Transaction management (Advanced)
+ * Transaction management (Advanced). Can only be called after `mo_setup()`.
  */
 
 bool mo_isTransactionAuthorized();
@@ -625,18 +633,19 @@ bool mo_getConfigurationString(const char *key, const char **valueOut); //need t
 //Add new Variable or Config. If running OCPP 2.0.1, `key16` can be NULL. If running OCPP 1.6,
 //`component201` and `name201` can be NULL. `component201`, `name201` and `key16` are zero-copy,
 //i.e. must outlive the MO lifecycle. Add before `mo_setup()`. At first boot, MO uses `factoryDefault`.
-//At subsequent boots, it loads the values from flash during `mo_setup()`
+//At subsequent boots, it loads the values from flash during `mo_setup()`. Call before `mo_setup()`.
 bool mo_declareVarConfigInt(MO_Context *ctx, const char *component201, const char *name201, const char *key16, int factoryDefault, MO_Mutability mutability, bool persistent, bool rebootRequired);
 bool mo_declareVarConfigBool(MO_Context *ctx, const char *component201, const char *name201, const char *key16, bool factoryDefault, MO_Mutability mutability, bool persistent, bool rebootRequired);
 bool mo_declareVarConfigString(MO_Context *ctx, const char *component201, const char *name201, const char *key16, const char *factoryDefault, MO_Mutability mutability, bool persistent, bool rebootRequired);
 
-//Set Variable or Config value. Set after `mo_setup()`. If running OCPP 2.0.1, `key16` can be NULL
+//Set Variable or Config value. Set after `mo_setup()`. If running OCPP 2.0.1, `key16` can be NULL.
+//Call after `mo_setup()`.
 bool mo_setVarConfigInt(MO_Context *ctx, const char *component201, const char *name201, const char *key16, int value);
 bool mo_setVarConfigBool(MO_Context *ctx, const char *component201, const char *name201, const char *key16, bool value);
 bool mo_setVarConfigString(MO_Context *ctx, const char *component201, const char *name201, const char *key16, const char *value);
 
 //Get Config value. MO writes the value into `valueOut`. Call after `mo_setup()`. If running
-//OCPP 2.0.1, `key16` can be NULL
+//OCPP 2.0.1, `key16` can be NULL. Call after `mo_setup()`.
 bool mo_getVarConfigInt(MO_Context *ctx, const char *component201, const char *name201, const char *key16, int *valueOut);
 bool mo_getVarConfigBool(MO_Context *ctx, const char *component201, const char *name201, const char *key16, bool *valueOut);
 bool mo_getVarConfigString(MO_Context *ctx, const char *component201, const char *name201, const char *key16, const char **valueOut); //need to copy `valueOut` into own buffer. `valueOut` may be invalidated after call
@@ -681,27 +690,28 @@ bool mo_setup2(MO_Context *ctx);
 void mo_deinitialize2(MO_Context *ctx);
 void mo_loop2(MO_Context *ctx);
 
-//Send operation manually and bypass MO business logic
+//Send operation manually and bypass MO business logic. Call after `mo_setup()`.
 bool mo_sendRequest(MO_Context *ctx,
         const char *operationType, //zero-copy, i.e. must outlive MO
         const char *payloadJson, //copied, i.e. can be invalidated
         void (*onResponse)(const char *payloadJson, void *userData),
         void (*onAbort)(void *userData),
         void *userData);
 
-//Set custom operation handler for incoming reqeusts and bypass MO business logic
+//Set custom operation handler for incoming reqeusts and bypass MO business logic. Call before
+//`mo_setup()`.
 bool mo_setRequestHandler(MO_Context *ctx, const char *operationType,
         void (*onRequest)(const char *operationType, const char *payloadJson, void **userStatus, void *userData),
         int (*writeResponse)(const char *operationType, char *buf, size_t size, void *userStatus, void *userData),
         void (*finally)(const char *operationType, void *userStatus, void *userData),
         void *userData);
 
-//Sniff incoming requests without control over the response
+//Sniff incoming requests without control over the response. Call before `mo_setup()`.
 bool mo_setOnReceiveRequest(MO_Context *ctx, const char *operationType,
         void (*onRequest)(const char *operationType, const char *payloadJson, void *userData),
         void *userData);
 
-//Sniff outgoing responses generated by MO
+//Sniff outgoing responses generated by MO. Call before `mo_setup()`.
 bool mo_setOnSendConf(MO_Context *ctx, const char *operationType,
         void (*onSendConf)(const char *operationType, const char *payloadJson, void *userData),
         void *userData);