Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
Dependents: TYBLE16_simple_data_logger TYBLE16_MP3_Air
Diff: drivers/I2CSlave.h
- Revision:
- 1:9db0e321a9f4
- Parent:
- 0:5b88d5760320
--- a/drivers/I2CSlave.h Tue Dec 17 23:23:45 2019 +0000
+++ b/drivers/I2CSlave.h Tue Dec 31 06:02:27 2019 +0000
@@ -1,5 +1,5 @@
/* mbed Microcontroller Library
- * Copyright (c) 2006-2013 ARM Limited
+ * Copyright (c) 2006-2019 ARM Limited
* SPDX-License-Identifier: Apache-2.0
*
* Licensed under the Apache License, Version 2.0 (the "License");
@@ -24,7 +24,11 @@
#include "hal/i2c_api.h"
namespace mbed {
-/** \addtogroup drivers */
+/**
+ * \defgroup drivers_I2CSlave I2CSlave class
+ * \ingroup drivers-public-api-i2c
+ * @{
+ */
/** An I2C Slave, used for communicating with an I2C Master device.
*
@@ -64,7 +68,6 @@
* }
* }
* @endcode
- * @ingroup drivers
*/
class I2CSlave {
@@ -83,6 +86,13 @@
*/
I2CSlave(PinName sda, PinName scl);
+ /** Create an I2C Slave interface, connected to the specified pins.
+ *
+ * @param static_pinmap reference to structure which holds static pinmap.
+ */
+ I2CSlave(const i2c_pinmap_t &static_pinmap);
+ I2CSlave(const i2c_pinmap_t &&) = delete; // prevent passing of temporary objects
+
/** Set the frequency of the I2C interface.
*
* @param hz The bus frequency in Hertz.
@@ -160,6 +170,8 @@
#endif //!defined(DOXYGEN_ONLY)
};
+/** @}*/
+
} // namespace mbed
#endif