ST / ST_INTERFACES

Official interfaces for ST components.

Dependents:   X_NUCLEO_IKS01A1 mDot_X_NUCLEO_IKS01A1 53L0A1 X_NUCLEO_IKS01A1 ... more

Fork of ST_INTERFACES by Davide Aliprandi

This library contains all abstract classes which together constitute the common API to which all existing and future ST components will adhere to.

Files at this revision

API Documentation at this revision

Revision 4:8f70f7159316, committed 2017-03-10

Comitter:
davide.aliprandi@st.com
Date:
Fri Mar 10 11:03:17 2017 +0100
Parent:
3:b1bb477e115e
Child:
5:d3c9b33b992c
Commit message:
Aligning to ARM mbed coding style.

Changed in this revision

Communications/Nfc.h Show annotated file Show diff for this revision Revisions of this file
Sensors/LightSensor.h Show annotated file Show diff for this revision Revisions of this file
Sensors/RangeSensor.h Show annotated file Show diff for this revision Revisions of this file 
--- a/Communications/Nfc.h	Fri Mar 10 10:50:53 2017 +0100
+++ b/Communications/Nfc.h	Fri Mar 10 11:03:17 2017 +0100
@@ -65,21 +65,21 @@
 
     /**
      * Read data from the tag.
-     * @param Offset Read offset.
-     * @param NbByteToRead Number of bytes to read.
-     * @param[out] pBufferRead Buffer to store the read data into.
+     * @param offset Read offset.
+     * @param nb_bytes_to_read Number of bytes to read.
+     * @param[out] p_buffer_read Buffer to store the read data into.
      * @return NFC_SUCCESS if no errors 
      */
-    virtual int read_binary(uint16_t Offset, uint8_t NbByteToRead, uint8_t *pBufferRead) = 0;
+    virtual int read_binary(uint16_t offset, uint8_t nb_bytes_to_read, uint8_t *p_buffer_read) = 0;
 
     /**
      * Write data to the tag.
-     * @param Offset Write offset.
-     * @param NbByteToWrite Number of bytes to write.
-     * @param pDataToWrite Buffer to write.
+     * @param offset Write offset.
+     * @param nb_bytes_to_write Number of bytes to write.
+     * @param p_buffer_write Buffer to write.
      * @return NFC_SUCCESS if no errors
      */
-    virtual int update_binary(uint16_t Offset, uint8_t NbByteToWrite, uint8_t *pDataToWrite) = 0;
+    virtual int update_binary(uint16_t offset, uint8_t nb_bytes_to_write, uint8_t *p_buffer_write) = 0;
 
     /**
      * @brief Destructor.

--- a/Sensors/LightSensor.h	Fri Mar 10 10:50:53 2017 +0100
+++ b/Sensors/LightSensor.h	Fri Mar 10 11:03:17 2017 +0100
@@ -58,10 +58,10 @@
 
     /**
      * @brief       Get current light [lux]
-     * @param[out]  piData Pointer to where to store light to
+     * @param[out]  pi_data Pointer to where to store light to
      * @return      0 in case of success, an error code otherwise
      */
-    virtual int get_lux(uint32_t *piData) = 0;
+    virtual int get_lux(uint32_t *pi_data) = 0;
 
     /**
      * @brief Destructor.

--- a/Sensors/RangeSensor.h	Fri Mar 10 10:50:53 2017 +0100
+++ b/Sensors/RangeSensor.h	Fri Mar 10 11:03:17 2017 +0100
@@ -58,10 +58,10 @@
 
     /**
      * @brief       Get current range [mm]
-     * @param[out]  piData Pointer to where to store range to
+     * @param[out]  pi_data Pointer to where to store range to
      * @return      0 in case of success, an error code otherwise
      */
-    virtual int get_distance(uint32_t *piData) = 0;
+    virtual int get_distance(uint32_t *pi_data) = 0;
 
     /**
      * @brief Destructor.