diff --git a/extras/Doxyfile b/extras/Doxyfile index 700fde9..b7b3ae2 100644 --- a/extras/Doxyfile +++ b/extras/Doxyfile @@ -38,7 +38,7 @@ PROJECT_NAME = muCom # could be handy for archiving the generated documentation or if some version # control system is used. -PROJECT_NUMBER = 1.3 +PROJECT_NUMBER = 2.0 # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer a diff --git a/extras/html/annotated.html b/extras/html/annotated.html index 23c1ca2..d39857a 100644 --- a/extras/html/annotated.html +++ b/extras/html/annotated.html @@ -19,7 +19,7 @@
muCom -  1.3 +  2.0
The reliable, fast and easy way to exchange binary data via UART
@@ -46,9 +46,9 @@
Here are the classes, structs, unions and interfaces with brief descriptions:
- + - +
 CmuComFile containing the main class for the muCom interface when being used for an Arduino
 CmuComMain class for the muCom interface when being used for an Arduino
 CmuCom_LinkedVariable_strInternal structure to store references to linked variables
 CmuComBaseBase muCom class
 CmuComBaseBase muCom class
diff --git a/extras/html/classes.html b/extras/html/classes.html index 15bf486..4744a84 100644 --- a/extras/html/classes.html +++ b/extras/html/classes.html @@ -19,7 +19,7 @@
muCom -  1.3 +  2.0
The reliable, fast and easy way to exchange binary data via UART
diff --git a/extras/html/classmu_com-members.html b/extras/html/classmu_com-members.html index a090134..6020232 100644 --- a/extras/html/classmu_com-members.html +++ b/extras/html/classmu_com-members.html @@ -19,7 +19,7 @@
muCom -  1.3 +  2.0
The reliable, fast and easy way to exchange binary data via UART
@@ -62,31 +62,34 @@ linkVariable(uint8_t index, uint64_t *var) (defined in muComBase)muComBaseinline linkVariable(uint8_t index, int64_t *var) (defined in muComBase)muComBaseinline linkVariable(uint8_t index, float *var) (defined in muComBase)muComBaseinline - muCom(Stream &ser, uint8_t num_var, uint8_t num_func) (defined in muCom)muCom - muComBase(uint8_t num_var, uint8_t num_func)muComBase - read(uint8_t index, uint8_t *data, uint8_t cnt)muComBase - readByte(uint8_t index, uint8_t *data)muComBaseinline - readByte(uint8_t index, int8_t *data) (defined in muComBase)muComBaseinline - readByte(uint8_t index)muComBase - readFloat(uint8_t index, float *data)muComBaseinline - readFloat(uint8_t index)muComBase - readLong(uint8_t index, uint32_t *data)muComBaseinline - readLong(uint8_t index, int32_t *data) (defined in muComBase)muComBaseinline - readLong(uint8_t index)muComBase - readLongLong(uint8_t index, uint64_t *data)muComBaseinline - readLongLong(uint8_t index, int64_t *data) (defined in muComBase)muComBaseinline - readLongLong(uint8_t index)muComBase - readShort(uint8_t index, uint16_t *data)muComBaseinline - readShort(uint8_t index, int16_t *data) (defined in muComBase)muComBaseinline - readShort(uint8_t index)muComBase - setTimeout(int16_t timeout)muComBase - write(uint8_t index, uint8_t *data, uint8_t cnt)muComBaseinline - writeByte(uint8_t index, uint8_t data)muComBaseinline + linkVariable(uint8_t index, double *var) (defined in muComBase)muComBaseinline + muCom(Stream &ser, struct muCom_LinkedVariable_str *var_buf, uint8_t num_var, muComFunc *func_buf, uint8_t num_func) (defined in muCom)muCom + muComBase(struct muCom_LinkedVariable_str *var_buf, uint8_t num_var, muComFunc *func_buf, uint8_t num_func)muComBase + read(uint8_t index, uint8_t *data, uint8_t cnt)muComBase + readByte(uint8_t index, uint8_t *data)muComBaseinline + readByte(uint8_t index, int8_t *data) (defined in muComBase)muComBaseinline + readByte(uint8_t index)muComBase + readDouble(uint8_t index, double *data)muComBaseinline + readDouble(uint8_t index)muComBase + readFloat(uint8_t index, float *data)muComBaseinline + readFloat(uint8_t index)muComBase + readLong(uint8_t index, uint32_t *data)muComBaseinline + readLong(uint8_t index, int32_t *data) (defined in muComBase)muComBaseinline + readLong(uint8_t index)muComBase + readLongLong(uint8_t index, uint64_t *data)muComBaseinline + readLongLong(uint8_t index, int64_t *data) (defined in muComBase)muComBaseinline + readLongLong(uint8_t index)muComBase + readShort(uint8_t index, uint16_t *data)muComBaseinline + readShort(uint8_t index, int16_t *data) (defined in muComBase)muComBaseinline + readShort(uint8_t index)muComBase + setTimeout(int16_t timeout)muComBase + write(uint8_t index, uint8_t *data, uint8_t cnt)muComBaseinline + writeByte(uint8_t index, uint8_t data)muComBaseinline + writeDouble(uint8_t index, double data)muComBaseinline writeFloat(uint8_t index, float data)muComBaseinline writeLong(uint8_t index, uint32_t data)muComBaseinline writeLongLong(uint8_t index, uint64_t data)muComBaseinline writeShort(uint8_t index, uint16_t data)muComBaseinline - ~muComBase(void)muComBase
diff --git a/extras/html/classmu_com.html b/extras/html/classmu_com.html index e65834d..20b6b26 100644 --- a/extras/html/classmu_com.html +++ b/extras/html/classmu_com.html @@ -19,7 +19,7 @@
muCom -  1.3 +  2.0
The reliable, fast and easy way to exchange binary data via UART
@@ -48,7 +48,7 @@
-

File containing the main class for the muCom interface when being used for an Arduino. +

Main class for the muCom interface when being used for an Arduino. More...

#include <muCom.h>

@@ -64,17 +64,13 @@ - - + + - - - - - - + + + @@ -82,13 +78,13 @@ - + - + - + @@ -117,6 +113,9 @@ + + @@ -141,6 +140,9 @@ + + + @@ -171,6 +173,9 @@ + + + @@ -186,13 +191,13 @@ + + +

Public Member Functions

- muCom (Stream &ser, uint8_t num_var, uint8_t num_func)
 
+ muCom (Stream &ser, struct muCom_LinkedVariable_str *var_buf, uint8_t num_var, muComFunc *func_buf, uint8_t num_func)
 
- Public Member Functions inherited from muComBase
 muComBase (uint8_t num_var, uint8_t num_func)
 Constructor of the base class. More...
 
- ~muComBase (void)
 Destructor of the base class.
 
 muComBase (struct muCom_LinkedVariable_str *var_buf, uint8_t num_var, muComFunc *func_buf, uint8_t num_func)
 Constructor of the base class. More...
 
uint32_t getLastCommTime (void)
 Get timestamp of last successful communication. More...
 
 Set timeout for read requests. More...
 
uint8_t handle (void)
 Handle the muCom interface. More...
 Handle the muCom interface. More...
 
int8_t linkFunction (uint8_t index, muComFunc function)
 Link function to the muCom interface. More...
 Link function to the muCom interface. More...
 
int8_t linkVariable (uint8_t index, uint8_t *var, uint8_t size)
 Link a variable or a buffer to the muCom interface. More...
 Link a variable or a buffer to the muCom interface. More...
 
int8_t linkVariable (uint8_t index, uint8_t *var)
int8_t linkVariable (uint8_t index, float *var)
 
+int8_t linkVariable (uint8_t index, double *var)
 
void invokeFunction (uint8_t index, uint8_t *data, uint8_t cnt)
 Invoke a function at the communication partner. More...
 
void writeFloat (uint8_t index, float data)
 Write a float to the communication partner. More...
 
void writeDouble (uint8_t index, double data)
 Write a double to the communication partner (not available on AVR microcontrollers) More...
 
int8_t read (uint8_t index, uint8_t *data, uint8_t cnt)
 Read data from the communication partner. More...
 
int8_t readFloat (uint8_t index, float *data)
 Read a float from the communication partner. More...
 
int8_t readDouble (uint8_t index, double *data)
 Read a double from the communication partner (not available on AVR microcontrollers) More...
 
uint8_t readByte (uint8_t index)
 Read a byte from the communication partner. More...
 
float readFloat (uint8_t index)
 Read a float from the communication partner. More...
 
double readDouble (uint8_t index)
 Read a float from the communication partner. More...
 

Detailed Description

-

File containing the main class for the muCom interface when being used for an Arduino.

-
Version
1.0
-
Author
Kai Liebich
-

Main class for the muCom interface when being used for an Arduino

-

This class inherits all functions from the muCom base class (see muComBase) and additionally implements the interface for the HW access when using the muCom interface on an Arduino. It uses the Stream class for communication which can be implemented by the hardware and software UARTS, as well as USB serial emulations.

+

Main class for the muCom interface when being used for an Arduino.

+

This class inherits all functions from the muCom base class (see muComBase) and additionally implements the interface for the HW access when using the muCom interface on an Arduino. It uses the Stream class for communication which can be implemented by the hardware and software UARTS, as well as USB serial emulations.

The documentation for this class was generated from the following files:
diff --git a/extras/html/classmu_com_base.html b/extras/html/classmu_com_base.html index b6d22e3..076082f 100644 --- a/extras/html/classmu_com_base.html +++ b/extras/html/classmu_com_base.html @@ -19,7 +19,7 @@
muCom -  1.3 +  2.0
The reliable, fast and easy way to exchange binary data via UART
@@ -48,7 +48,7 @@
-

Base muCom class. +

Base muCom class. More...

#include <muComBase.h>

@@ -58,19 +58,15 @@
-muCom +muCom
- - - - - - + + + @@ -78,13 +74,13 @@ - + - + - + @@ -113,6 +109,9 @@ + + @@ -137,6 +136,9 @@ + + + @@ -167,6 +169,9 @@ + + + @@ -182,13 +187,16 @@ + + +

Public Member Functions

 muComBase (uint8_t num_var, uint8_t num_func)
 Constructor of the base class. More...
 
- ~muComBase (void)
 Destructor of the base class.
 
 muComBase (struct muCom_LinkedVariable_str *var_buf, uint8_t num_var, muComFunc *func_buf, uint8_t num_func)
 Constructor of the base class. More...
 
uint32_t getLastCommTime (void)
 Get timestamp of last successful communication. More...
 
 Set timeout for read requests. More...
 
uint8_t handle (void)
 Handle the muCom interface. More...
 Handle the muCom interface. More...
 
int8_t linkFunction (uint8_t index, muComFunc function)
 Link function to the muCom interface. More...
 Link function to the muCom interface. More...
 
int8_t linkVariable (uint8_t index, uint8_t *var, uint8_t size)
 Link a variable or a buffer to the muCom interface. More...
 Link a variable or a buffer to the muCom interface. More...
 
int8_t linkVariable (uint8_t index, uint8_t *var)
int8_t linkVariable (uint8_t index, float *var)
 
+int8_t linkVariable (uint8_t index, double *var)
 
void invokeFunction (uint8_t index, uint8_t *data, uint8_t cnt)
 Invoke a function at the communication partner. More...
 
void writeFloat (uint8_t index, float data)
 Write a float to the communication partner. More...
 
void writeDouble (uint8_t index, double data)
 Write a double to the communication partner (not available on AVR microcontrollers) More...
 
int8_t read (uint8_t index, uint8_t *data, uint8_t cnt)
 Read data from the communication partner. More...
 
int8_t readFloat (uint8_t index, float *data)
 Read a float from the communication partner. More...
 
int8_t readDouble (uint8_t index, double *data)
 Read a double from the communication partner (not available on AVR microcontrollers) More...
 
uint8_t readByte (uint8_t index)
 Read a byte from the communication partner. More...
 
float readFloat (uint8_t index)
 Read a float from the communication partner. More...
 
double readDouble (uint8_t index)
 Read a float from the communication partner. More...
 

Detailed Description

-

Base muCom class.

-

This class implements the muCom protocol itself and relies on being inherited in order to implement the actual serial interface.

+

Base muCom class.

+

This class implements the muCom protocol itself and relies on being inherited in order to implement the actual serial interface.

Constructor & Destructor Documentation

- -

◆ muComBase()

+ +

◆ muComBase()

@@ -196,9 +204,21 @@

muComBase::muComBase ( + struct muCom_LinkedVariable_str *  + var_buf, + + + + uint8_t  num_var, + + + + muComFunc *  + func_buf, + @@ -216,7 +236,9 @@

Parameters
+ +
[in]var_bufFixed buffer for linked variables
[in]num_varMax. number of variables to be linked
[in]func_bufFixed buffer for linked functions
[in]num_funcMax. number of functions to be linked
@@ -270,8 +292,8 @@

-

Handle the muCom interface.

-

This function handles the muCom interface and decodes the received data. It should be executed as often as possible and will handle writing to and reading from linked variables as well as executing requested functions. This function is also used during reading data from the communication partner.

Returns
1 = answer from a read request was received, else 0
+

Handle the muCom interface.

+

This function handles the muCom interface and decodes the received data. It should be executed as often as possible and will handle writing to and reading from linked variables as well as executing requested functions. This function is also used during reading data from the communication partner.

Returns
1 = answer from a read request was received, else 0

@@ -387,7 +409,7 @@

-

Link function to the muCom interface.

+

Link function to the muCom interface.

Parameters
@@ -430,7 +452,7 @@

-

Link a variable or a buffer to the muCom interface.

+

Link a variable or a buffer to the muCom interface.

Parameters

[in]indexIndex used to invoke this functions
@@ -557,7 +579,81 @@

Returns
See muCom error codes (0 = OK, <0 = Error)
+
Returns
See muCom error codes (0 = OK, <0 = Error)
+ + + + +

◆ readDouble() [1/2]

+ +
+
+

[in]indexIndex used to access the variable/buffer
+ + + + + + + +
double muComBase::readDouble (uint8_t index)
+

+ +

Read a float from the communication partner.

+
Parameters
+ + +
[in]indexIndex of the remote variable to be read
+
+
+
Returns
Float read from the communication partner.
+-1 in case of errors
+ +
+ + +

◆ readDouble() [2/2]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
int8_t muComBase::readDouble (uint8_t index,
double * data 
)
+ 		+inline
+
+ +

Read a double from the communication partner (not available on AVR microcontrollers)

+
Parameters
+ + + +
[in]indexIndex of the remote variable to be read
[in]dataPointer to the variable where the read data should be stored
+
+
+
Returns
See muCom error codes (0 = OK, <0 = Error)
@@ -631,7 +727,7 @@

Returns
See muCom error codes (0 = OK, <0 = Error)
+
Returns
See muCom error codes (0 = OK, <0 = Error)
@@ -705,7 +801,7 @@

Returns
See muCom error codes (0 = OK, <0 = Error)
+
Returns
See muCom error codes (0 = OK, <0 = Error)
@@ -779,7 +875,7 @@

Returns
See muCom error codes (0 = OK, <0 = Error)
+
Returns
See muCom error codes (0 = OK, <0 = Error)
@@ -853,7 +949,7 @@

Returns
See muCom error codes (0 = OK, <0 = Error)
+
Returns
See muCom error codes (0 = OK, <0 = Error)
@@ -978,6 +1074,51 @@

+

◆ writeDouble()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
void muComBase::writeDouble (uint8_t index,
double data 
)
+ 		+inline
+
+ +

Write a double to the communication partner (not available on AVR microcontrollers)

+
Parameters
+ + + +
[in]indexIndex of the remote variable to be written to
[in]dataFloat to be written to the communication partner
+
+
+
diff --git a/extras/html/dir_68267d1309a1af8e8297ef4c3efbcdba.html b/extras/html/dir_68267d1309a1af8e8297ef4c3efbcdba.html index dd483ab..f6f1e40 100644 --- a/extras/html/dir_68267d1309a1af8e8297ef4c3efbcdba.html +++ b/extras/html/dir_68267d1309a1af8e8297ef4c3efbcdba.html @@ -19,7 +19,7 @@
muCom -  1.3 +  2.0
The reliable, fast and easy way to exchange binary data via UART
diff --git a/extras/html/files.html b/extras/html/files.html index 137ca26..0304e5c 100644 --- a/extras/html/files.html +++ b/extras/html/files.html @@ -19,7 +19,7 @@
muCom -  1.3 +  2.0
The reliable, fast and easy way to exchange binary data via UART
diff --git a/extras/html/functions.html b/extras/html/functions.html index d600f6d..f85f77b 100644 --- a/extras/html/functions.html +++ b/extras/html/functions.html @@ -19,7 +19,7 @@
muCom -  1.3 +  2.0
The reliable, fast and easy way to exchange binary data via UART
@@ -57,7 +57,7 @@ : muComBase
  • muComBase() -: muComBase +: muComBase
  • read() : muComBase @@ -65,14 +65,17 @@
  • readByte() : muComBase
    • +
  • readDouble() +: muComBase +
  • readFloat() : muComBase
  • readLong() -: muComBase +: muComBase
  • readLongLong() -: muComBase +: muComBase
  • readShort() : muComBase @@ -86,6 +89,9 @@
  • writeByte() : muComBase
    • +
  • writeDouble() +: muComBase +
  • writeFloat() : muComBase
    • @@ -98,9 +104,6 @@
  • writeShort() : muComBase
    • -
  • ~muComBase() -: muComBase -
    • diff --git a/extras/html/functions_func.html b/extras/html/functions_func.html index e8f2d13..79d9181 100644 --- a/extras/html/functions_func.html +++ b/extras/html/functions_func.html @@ -19,7 +19,7 @@
    muCom -  1.3 +  2.0
    The reliable, fast and easy way to exchange binary data via UART
    @@ -57,7 +57,7 @@ : muComBase
  • muComBase() -: muComBase +: muComBase
  • read() : muComBase @@ -65,14 +65,17 @@
  • readByte() : muComBase
    • +
  • readDouble() +: muComBase +
  • readFloat() : muComBase
  • readLong() -: muComBase +: muComBase
  • readLongLong() -: muComBase +: muComBase
  • readShort() : muComBase @@ -86,6 +89,9 @@
  • writeByte() : muComBase
    • +
  • writeDouble() +: muComBase +
  • writeFloat() : muComBase
    • @@ -98,9 +104,6 @@
  • writeShort() : muComBase
    • -
  • ~muComBase() -: muComBase -
    • diff --git a/extras/html/hierarchy.html b/extras/html/hierarchy.html index ccee170..ec5af10 100644 --- a/extras/html/hierarchy.html +++ b/extras/html/hierarchy.html @@ -19,7 +19,7 @@
    muCom -  1.3 +  2.0
    The reliable, fast and easy way to exchange binary data via UART
    @@ -47,8 +47,8 @@
    This inheritance list is sorted roughly, but not completely, alphabetically:
    [detail level 12]
    - - + +
     CmuCom_LinkedVariable_strInternal structure to store references to linked variables
     ▼CmuComBaseBase muCom class
     CmuComFile containing the main class for the muCom interface when being used for an Arduino
     ▼CmuComBaseBase muCom class
     CmuComMain class for the muCom interface when being used for an Arduino
    diff --git a/extras/html/index.html b/extras/html/index.html index 244772a..5827fa3 100644 --- a/extras/html/index.html +++ b/extras/html/index.html @@ -19,7 +19,7 @@
    muCom -  1.3 +  2.0
    The reliable, fast and easy way to exchange binary data via UART
    diff --git a/extras/html/mu_com_8h_source.html b/extras/html/mu_com_8h_source.html index 766e568..3f53016 100644 --- a/extras/html/mu_com_8h_source.html +++ b/extras/html/mu_com_8h_source.html @@ -19,7 +19,7 @@
    muCom -  1.3 +  2.0
    The reliable, fast and easy way to exchange binary data via UART
    @@ -55,43 +55,49 @@
    11 #include <Arduino.h>
    12 #include "muComBase.h"
    13 
    -
    14 
    -
    21 class muCom : public muComBase
    -
    22 {
    -
    23  private:
    -
    24  Stream *_ser;
    -
    25 
    -
    26  inline void _write(uint8_t* data, uint8_t cnt)
    -
    27  { this->_ser->write(data, cnt); }
    -
    28 
    -
    29  inline uint8_t _read(void)
    -
    30  { return this->_ser->read(); }
    -
    31 
    -
    32  inline uint8_t _available(void)
    -
    33  { return this->_ser->available(); }
    -
    34 
    -
    35  inline void _flushTx(void)
    -
    36  { this->_ser->flush(); }
    -
    37 
    -
    38  inline uint32_t _getTimestamp(void)
    -
    39  { return millis(); }
    -
    40 
    -
    41  inline void _disableInterrupts(void)
    -
    42  { noInterrupts(); }
    -
    43 
    -
    44  inline void _enableInterrupts(void)
    -
    45  { interrupts(); }
    -
    46 
    -
    47  public:
    -
    48  muCom(Stream &ser, uint8_t num_var, uint8_t num_func);
    -
    49 };
    -
    50 
    -
    51 
    -
    52 #endif //MUCOM_H
    +
    14 #define MUCOM_CREATE(name, serial, num_var, num_func) \
    +
    15  struct muCom_LinkedVariable_str _##name##_var_buf[ num_var ]; \
    +
    16  muComFunc _##name##_func_buf[ num_func ]; \
    +
    17  muCom name(serial, _##name##_var_buf, num_var, _##name##_func_buf, num_func);
    +
    18 
    +
    19 
    +
    26 class muCom : public muComBase
    +
    27 {
    +
    28  private:
    +
    29  Stream *_ser;
    +
    30 
    +
    31  inline void _write(uint8_t* data, uint8_t cnt)
    +
    32  { this->_ser->write(data, cnt); }
    +
    33 
    +
    34  inline uint8_t _read(void)
    +
    35  { return this->_ser->read(); }
    +
    36 
    +
    37  inline uint8_t _available(void)
    +
    38  { return this->_ser->available(); }
    +
    39 
    +
    40  inline void _flushTx(void)
    +
    41  { this->_ser->flush(); }
    +
    42 
    +
    43  inline uint32_t _getTimestamp(void)
    +
    44  { return millis(); }
    +
    45 
    +
    46  inline void _disableInterrupts(void)
    +
    47  { noInterrupts(); }
    +
    48 
    +
    49  inline void _enableInterrupts(void)
    +
    50  { interrupts(); }
    +
    51 
    +
    52  public:
    +
    53  muCom(Stream &ser, struct muCom_LinkedVariable_str *var_buf, uint8_t num_var, muComFunc *func_buf, uint8_t num_func);
    +
    54 };
    +
    55 
    +
    56 
    +
    57 #endif //MUCOM_H
    muComBase::write
    void write(uint8_t index, uint8_t *data, uint8_t cnt)
    Write a data array to a remote variable.
    Definition: muComBase.h:203
    muComBase
    Base muCom class.
    Definition: muComBase.h:57
    -
    muCom
    File containing the main class for the muCom interface when being used for an Arduino.
    Definition: muCom.h:21
    +
    muCom_LinkedVariable_str
    Internal structure to store references to linked variables.
    Definition: muComBase.h:46
    +
    muCom
    Main class for the muCom interface when being used for an Arduino.
    Definition: muCom.h:26
    Generated by   diff --git a/extras/html/mu_com_base_8h_source.html b/extras/html/mu_com_base_8h_source.html index d4a6627..a86af6a 100644 --- a/extras/html/mu_com_base_8h_source.html +++ b/extras/html/mu_com_base_8h_source.html @@ -19,7 +19,7 @@
    muCom -  1.3 +  2.0
    The reliable, fast and easy way to exchange binary data via UART
    @@ -125,54 +125,55 @@
    92 
    93 
    94  public:
    -
    100  muComBase(uint8_t num_var, uint8_t num_func);
    -
    101 
    -
    102 
    -
    106  ~muComBase(void);
    -
    107 
    -
    108 
    -
    113  inline uint32_t getLastCommTime(void)
    -
    114  { return this->_lastCommTime; }
    -
    115 
    -
    116 
    -
    121  void setTimeout(int16_t timeout);
    -
    122 
    -
    123 
    -
    131  uint8_t handle(void);
    -
    132 
    -
    133 
    -
    139  int8_t linkFunction(uint8_t index, muComFunc function);
    -
    140 
    -
    141 
    -
    149  int8_t linkVariable(uint8_t index, uint8_t *var, uint8_t size);
    -
    150 
    -
    151  inline int8_t linkVariable(uint8_t index, uint8_t *var)
    -
    152  { return this->linkVariable(index, (uint8_t*)var, sizeof(uint8_t)); }
    -
    153 
    -
    154  inline int8_t linkVariable(uint8_t index, int8_t *var)
    -
    155  { return this->linkVariable(index, (uint8_t*)var, sizeof(int8_t)); }
    -
    156 
    -
    157  inline int8_t linkVariable(uint8_t index, uint16_t *var)
    -
    158  { return this->linkVariable(index, (uint8_t*)var, sizeof(uint16_t)); }
    -
    159 
    -
    160  inline int8_t linkVariable(uint8_t index, int16_t *var)
    -
    161  { return this->linkVariable(index, (uint8_t*)var, sizeof(int16_t)); }
    -
    162 
    -
    163  inline int8_t linkVariable(uint8_t index, uint32_t *var)
    -
    164  { return this->linkVariable(index, (uint8_t*)var, sizeof(uint32_t)); }
    -
    165 
    -
    166  inline int8_t linkVariable(uint8_t index, int32_t *var)
    -
    167  { return this->linkVariable(index, (uint8_t*)var, sizeof(int32_t)); }
    -
    168 
    -
    169  inline int8_t linkVariable(uint8_t index, uint64_t *var)
    -
    170  { return this->linkVariable(index, (uint8_t*)var, sizeof(uint64_t)); }
    -
    171 
    -
    172  inline int8_t linkVariable(uint8_t index, int64_t *var)
    -
    173  { return this->linkVariable(index, (uint8_t*)var, sizeof(int64_t)); }
    -
    174 
    -
    175  inline int8_t linkVariable(uint8_t index, float *var)
    -
    176  { return this->linkVariable(index, (uint8_t*)var, sizeof(float)); }
    -
    177 
    +
    102  muComBase(struct muCom_LinkedVariable_str *var_buf, uint8_t num_var, muComFunc *func_buf, uint8_t num_func);
    +
    103 
    +
    104 
    +
    109  inline uint32_t getLastCommTime(void)
    +
    110  { return this->_lastCommTime; }
    +
    111 
    +
    112 
    +
    117  void setTimeout(int16_t timeout);
    +
    118 
    +
    119 
    +
    127  uint8_t handle(void);
    +
    128 
    +
    129 
    +
    135  int8_t linkFunction(uint8_t index, muComFunc function);
    +
    136 
    +
    137 
    +
    145  int8_t linkVariable(uint8_t index, uint8_t *var, uint8_t size);
    +
    146 
    +
    147  inline int8_t linkVariable(uint8_t index, uint8_t *var)
    +
    148  { return this->linkVariable(index, (uint8_t*)var, sizeof(uint8_t)); }
    +
    149 
    +
    150  inline int8_t linkVariable(uint8_t index, int8_t *var)
    +
    151  { return this->linkVariable(index, (uint8_t*)var, sizeof(int8_t)); }
    +
    152 
    +
    153  inline int8_t linkVariable(uint8_t index, uint16_t *var)
    +
    154  { return this->linkVariable(index, (uint8_t*)var, sizeof(uint16_t)); }
    +
    155 
    +
    156  inline int8_t linkVariable(uint8_t index, int16_t *var)
    +
    157  { return this->linkVariable(index, (uint8_t*)var, sizeof(int16_t)); }
    +
    158 
    +
    159  inline int8_t linkVariable(uint8_t index, uint32_t *var)
    +
    160  { return this->linkVariable(index, (uint8_t*)var, sizeof(uint32_t)); }
    +
    161 
    +
    162  inline int8_t linkVariable(uint8_t index, int32_t *var)
    +
    163  { return this->linkVariable(index, (uint8_t*)var, sizeof(int32_t)); }
    +
    164 
    +
    165  inline int8_t linkVariable(uint8_t index, uint64_t *var)
    +
    166  { return this->linkVariable(index, (uint8_t*)var, sizeof(uint64_t)); }
    +
    167 
    +
    168  inline int8_t linkVariable(uint8_t index, int64_t *var)
    +
    169  { return this->linkVariable(index, (uint8_t*)var, sizeof(int64_t)); }
    +
    170 
    +
    171  inline int8_t linkVariable(uint8_t index, float *var)
    +
    172  { return this->linkVariable(index, (uint8_t*)var, sizeof(float)); }
    +
    173 
    +
    174  #ifndef __AVR__
    +
    175  inline int8_t linkVariable(uint8_t index, double *var)
    +
    176  { return this->linkVariable(index, (uint8_t*)var, sizeof(double)); }
    +
    177  #endif
    178 
    185  inline void invokeFunction(uint8_t index, uint8_t* data, uint8_t cnt)
    186  { this->writeRaw(MUCOM_EXECUTE_REQUEST, index, data, cnt); }
    @@ -199,73 +200,93 @@
    243  inline void writeFloat(uint8_t index, float data)
    244  { this->write(index, (uint8_t*)&data, sizeof(float)); }
    245 
    -
    246 
    -
    253  int8_t read(uint8_t index, uint8_t *data, uint8_t cnt);
    -
    254 
    -
    261  inline int8_t readByte(uint8_t index, uint8_t *data)
    -
    262  { return this->read(index, (uint8_t*)data, sizeof(uint8_t)); }
    -
    263 
    -
    264  inline int8_t readByte(uint8_t index, int8_t *data)
    -
    265  { return this->read(index, (uint8_t*)data, sizeof(int8_t)); }
    -
    266 
    -
    273  inline int8_t readShort(uint8_t index, uint16_t *data)
    -
    274  { return this->read(index, (uint8_t*)data, sizeof(uint16_t)); }
    -
    275 
    -
    276  inline int8_t readShort(uint8_t index, int16_t *data)
    -
    277  { return this->read(index, (uint8_t*)data, sizeof(int16_t)); }
    -
    278 
    -
    285  inline int8_t readLong(uint8_t index, uint32_t *data)
    -
    286  { return this->read(index, (uint8_t*)data, sizeof(uint32_t)); }
    -
    287 
    -
    288  inline int8_t readLong(uint8_t index, int32_t *data)
    -
    289  { return this->read(index, (uint8_t*)data, sizeof(int32_t)); }
    -
    290 
    -
    297  inline int8_t readLongLong(uint8_t index, uint64_t *data)
    -
    298  { return this->read(index, (uint8_t*)data, sizeof(uint64_t)); }
    -
    299 
    -
    300  inline int8_t readLongLong(uint8_t index, int64_t *data)
    -
    301  { return this->read(index, (uint8_t*)data, sizeof(int64_t)); }
    -
    302 
    -
    309  inline int8_t readFloat(uint8_t index, float *data)
    -
    310  { return this->read(index, (uint8_t*)data, sizeof(float)); }
    -
    311 
    -
    318  uint8_t readByte(uint8_t index);
    -
    319 
    -
    326  uint16_t readShort(uint8_t index);
    -
    327 
    -
    334  uint32_t readLong(uint8_t index);
    +
    246  #ifndef __AVR__
    +
    247 
    +
    253  inline void writeDouble(uint8_t index, double data)
    +
    254  { this->write(index, (uint8_t*)&data, sizeof(double)); }
    +
    255 
    +
    256  #endif
    +
    257 
    +
    264  int8_t read(uint8_t index, uint8_t *data, uint8_t cnt);
    +
    265 
    +
    272  inline int8_t readByte(uint8_t index, uint8_t *data)
    +
    273  { return this->read(index, (uint8_t*)data, sizeof(uint8_t)); }
    +
    274 
    +
    275  inline int8_t readByte(uint8_t index, int8_t *data)
    +
    276  { return this->read(index, (uint8_t*)data, sizeof(int8_t)); }
    +
    277 
    +
    284  inline int8_t readShort(uint8_t index, uint16_t *data)
    +
    285  { return this->read(index, (uint8_t*)data, sizeof(uint16_t)); }
    +
    286 
    +
    287  inline int8_t readShort(uint8_t index, int16_t *data)
    +
    288  { return this->read(index, (uint8_t*)data, sizeof(int16_t)); }
    +
    289 
    +
    296  inline int8_t readLong(uint8_t index, uint32_t *data)
    +
    297  { return this->read(index, (uint8_t*)data, sizeof(uint32_t)); }
    +
    298 
    +
    299  inline int8_t readLong(uint8_t index, int32_t *data)
    +
    300  { return this->read(index, (uint8_t*)data, sizeof(int32_t)); }
    +
    301 
    +
    308  inline int8_t readLongLong(uint8_t index, uint64_t *data)
    +
    309  { return this->read(index, (uint8_t*)data, sizeof(uint64_t)); }
    +
    310 
    +
    311  inline int8_t readLongLong(uint8_t index, int64_t *data)
    +
    312  { return this->read(index, (uint8_t*)data, sizeof(int64_t)); }
    +
    313 
    +
    320  inline int8_t readFloat(uint8_t index, float *data)
    +
    321  { return this->read(index, (uint8_t*)data, sizeof(float)); }
    +
    322 
    +
    323  #ifndef __AVR__
    +
    324 
    +
    331  inline int8_t readDouble(uint8_t index, double *data)
    +
    332  { return this->read(index, (uint8_t*)data, sizeof(float)); }
    +
    333 
    +
    334  #endif
    335 
    -
    342  uint64_t readLongLong(uint8_t index);
    +
    342  uint8_t readByte(uint8_t index);
    343 
    -
    350  float readFloat(uint8_t index);
    -
    351 };
    -
    352 
    -
    353 
    -
    354 #endif //MUCOMBASE_H
    +
    350  uint16_t readShort(uint8_t index);
    +
    351 
    +
    358  uint32_t readLong(uint8_t index);
    +
    359 
    +
    366  uint64_t readLongLong(uint8_t index);
    +
    367 
    +
    374  float readFloat(uint8_t index);
    +
    375 
    +
    376  #ifndef __AVR__
    +
    377 
    +
    384  double readDouble(uint8_t index);
    +
    385 
    +
    386  #endif
    +
    387 };
    +
    388 
    +
    389 
    +
    390 #endif //MUCOMBASE_H
    -
    muComBase::~muComBase
    ~muComBase(void)
    Destructor of the base class.
    Definition: muComBase.cpp:67
    muComBase::invokeFunction
    void invokeFunction(uint8_t index)
    Invoke a function at the communication partner.
    Definition: muComBase.h:193
    muComBase::writeShort
    void writeShort(uint8_t index, uint16_t data)
    Write a short (16 bit) to the communication partner.
    Definition: muComBase.h:219
    +
    muComBase::readDouble
    int8_t readDouble(uint8_t index, double *data)
    Read a double from the communication partner (not available on AVR microcontrollers)
    Definition: muComBase.h:331
    muComBase::write
    void write(uint8_t index, uint8_t *data, uint8_t cnt)
    Write a data array to a remote variable.
    Definition: muComBase.h:203
    -
    muComBase::readLongLong
    int8_t readLongLong(uint8_t index, uint64_t *data)
    Read a long long from the communication partner.
    Definition: muComBase.h:297
    +
    muComBase::readLongLong
    int8_t readLongLong(uint8_t index, uint64_t *data)
    Read a long long from the communication partner.
    Definition: muComBase.h:308
    muComBase::invokeFunction
    void invokeFunction(uint8_t index, uint8_t *data, uint8_t cnt)
    Invoke a function at the communication partner.
    Definition: muComBase.h:185
    muComBase::writeByte
    void writeByte(uint8_t index, uint8_t data)
    Write a byte (8 bit) to the communication partner.
    Definition: muComBase.h:211
    -
    muComBase::readShort
    int8_t readShort(uint8_t index, uint16_t *data)
    Read a short from the communication partner.
    Definition: muComBase.h:273
    +
    muComBase::readShort
    int8_t readShort(uint8_t index, uint16_t *data)
    Read a short from the communication partner.
    Definition: muComBase.h:284
    muComBase::writeLong
    void writeLong(uint8_t index, uint32_t data)
    Write a long (32 bit) to the communication partner.
    Definition: muComBase.h:227
    -
    muComBase::linkVariable
    int8_t linkVariable(uint8_t index, uint8_t *var, uint8_t size)
    Link a variable or a buffer to the muCom interface.
    Definition: muComBase.cpp:213
    -
    muComBase::readFloat
    int8_t readFloat(uint8_t index, float *data)
    Read a float from the communication partner.
    Definition: muComBase.h:309
    -
    muComBase::handle
    uint8_t handle(void)
    Handle the muCom interface.
    Definition: muComBase.cpp:86
    -
    muComBase::read
    int8_t read(uint8_t index, uint8_t *data, uint8_t cnt)
    Read data from the communication partner.
    Definition: muComBase.cpp:265
    +
    muComBase::linkVariable
    int8_t linkVariable(uint8_t index, uint8_t *var, uint8_t size)
    Link a variable or a buffer to the muCom interface.
    Definition: muComBase.cpp:208
    +
    muComBase::readFloat
    int8_t readFloat(uint8_t index, float *data)
    Read a float from the communication partner.
    Definition: muComBase.h:320
    +
    muComBase::handle
    uint8_t handle(void)
    Handle the muCom interface.
    Definition: muComBase.cpp:81
    +
    muComBase::read
    int8_t read(uint8_t index, uint8_t *data, uint8_t cnt)
    Read data from the communication partner.
    Definition: muComBase.cpp:260
    muComBase::writeLongLong
    void writeLongLong(uint8_t index, uint64_t data)
    Write a long long (64 bit) to the communication partner.
    Definition: muComBase.h:235
    -
    muComBase::muComBase
    muComBase(uint8_t num_var, uint8_t num_func)
    Constructor of the base class.
    Definition: muComBase.cpp:48
    muComBase::writeFloat
    void writeFloat(uint8_t index, float data)
    Write a float to the communication partner.
    Definition: muComBase.h:243
    -
    muComBase::getLastCommTime
    uint32_t getLastCommTime(void)
    Get timestamp of last successful communication.
    Definition: muComBase.h:113
    -
    muComBase::readByte
    int8_t readByte(uint8_t index, uint8_t *data)
    Read a byte from the communication partner.
    Definition: muComBase.h:261
    -
    muComBase::readLong
    int8_t readLong(uint8_t index, uint32_t *data)
    Read a long from the communication partner.
    Definition: muComBase.h:285
    +
    muComBase::getLastCommTime
    uint32_t getLastCommTime(void)
    Get timestamp of last successful communication.
    Definition: muComBase.h:109
    +
    muComBase::readByte
    int8_t readByte(uint8_t index, uint8_t *data)
    Read a byte from the communication partner.
    Definition: muComBase.h:272
    +
    muComBase::readLong
    int8_t readLong(uint8_t index, uint32_t *data)
    Read a long from the communication partner.
    Definition: muComBase.h:296
    muComBase
    Base muCom class.
    Definition: muComBase.h:57
    -
    muComBase::linkFunction
    int8_t linkFunction(uint8_t index, muComFunc function)
    Link function to the muCom interface.
    Definition: muComBase.cpp:199
    +
    muComBase::linkFunction
    int8_t linkFunction(uint8_t index, muComFunc function)
    Link function to the muCom interface.
    Definition: muComBase.cpp:194
    muCom_LinkedVariable_str
    Internal structure to store references to linked variables.
    Definition: muComBase.h:46
    -
    muComBase::setTimeout
    void setTimeout(int16_t timeout)
    Set timeout for read requests.
    Definition: muComBase.cpp:75
    +
    muComBase::writeDouble
    void writeDouble(uint8_t index, double data)
    Write a double to the communication partner (not available on AVR microcontrollers)
    Definition: muComBase.h:253
    +
    muComBase::setTimeout
    void setTimeout(int16_t timeout)
    Set timeout for read requests.
    Definition: muComBase.cpp:70
    +
    muComBase::muComBase
    muComBase(struct muCom_LinkedVariable_str *var_buf, uint8_t num_var, muComFunc *func_buf, uint8_t num_func)
    Constructor of the base class.
    Definition: muComBase.cpp:47
    Generated by   diff --git a/extras/html/structmu_com___linked_variable__str-members.html b/extras/html/structmu_com___linked_variable__str-members.html index e60108e..76b7b0d 100644 --- a/extras/html/structmu_com___linked_variable__str-members.html +++ b/extras/html/structmu_com___linked_variable__str-members.html @@ -19,7 +19,7 @@
    muCom -  1.3 +  2.0
    The reliable, fast and easy way to exchange binary data via UART
    diff --git a/extras/html/structmu_com___linked_variable__str.html b/extras/html/structmu_com___linked_variable__str.html index b8cbda4..fdc41e9 100644 --- a/extras/html/structmu_com___linked_variable__str.html +++ b/extras/html/structmu_com___linked_variable__str.html @@ -19,7 +19,7 @@
    muCom -  1.3 +  2.0
    The reliable, fast and easy way to exchange binary data via UART
    diff --git a/library.properties b/library.properties index 2ae00f4..3520f22 100644 --- a/library.properties +++ b/library.properties @@ -1,5 +1,5 @@ name=muCom -version=1.3 +version=2.0 author=Kai Liebich maintainer=Kai Liebich sentence=The reliable, fast and easy way to exchange binary data via UART