|
62 | 62 | class FRAM:
|
63 | 63 | """
|
64 | 64 | Driver base for the FRAM Breakout.
|
| 65 | +
|
| 66 | + :param int max_size: The maximum size of the EEPROM |
| 67 | + :param bool write_protect: Turns on/off initial write protection |
| 68 | + :param DigitalInOut wp_pin: (Optional) Physical pin connected to the ``WP`` breakout pin. |
| 69 | + Must be a ``DigitalInOut`` object. |
65 | 70 | """
|
66 | 71 |
|
67 | 72 | def __init__(self, max_size: int, write_protect: bool = False, wp_pin: Optional[DigitalInOut] = None) -> None:
|
@@ -222,11 +227,11 @@ def _write(self, start_address: int, data: Union[int, Sequence[int]], wraparound
|
222 | 227 | class FRAM_I2C(FRAM):
|
223 | 228 | """I2C class for FRAM.
|
224 | 229 |
|
225 |
| - :param: ~busio.I2C i2c_bus: The I2C bus the FRAM is connected to. |
226 |
| - :param: int address: I2C address of FRAM. Default address is ``0x50``. |
227 |
| - :param: bool write_protect: Turns on/off initial write protection. |
| 230 | + :param ~busio.I2C i2c_bus: The I2C bus the FRAM is connected to. |
| 231 | + :param int address: I2C address of FRAM. Default address is ``0x50``. |
| 232 | + :param bool write_protect: Turns on/off initial write protection. |
228 | 233 | Default is ``False``.
|
229 |
| - :param: wp_pin: (Optional) Physical pin connected to the ``WP`` breakout pin. |
| 234 | + :param wp_pin: (Optional) Physical pin connected to the ``WP`` breakout pin. |
230 | 235 | Must be a ``digitalio.DigitalInOut`` object.
|
231 | 236 | """
|
232 | 237 |
|
@@ -301,12 +306,12 @@ def write_protected(self, value: bool) -> None:
|
301 | 306 | class FRAM_SPI(FRAM):
|
302 | 307 | """SPI class for FRAM.
|
303 | 308 |
|
304 |
| - :param: ~busio.SPI spi_bus: The SPI bus the FRAM is connected to. |
305 |
| - :param: ~digitalio.DigitalInOut spi_cs: The SPI CS pin. |
306 |
| - :param: bool write_protect: Turns on/off initial write protection. |
307 |
| - Default is ``False``. |
308 |
| - :param: wp_pin: (Optional) Physical pin connected to the ``WP`` breakout pin. |
309 |
| - Must be a ``digitalio.DigitalInOut`` object. |
| 309 | + :param ~busio.SPI spi_bus: The SPI bus the FRAM is connected to. |
| 310 | + :param ~digitalio.DigitalInOut spi_cs: The SPI CS pin. |
| 311 | + :param bool write_protect: Turns on/off initial write protection. |
| 312 | + Default is ``False``. |
| 313 | + :param wp_pin: (Optional) Physical pin connected to the ``WP`` breakout pin. |
| 314 | + Must be a ``digitalio.DigitalInOut`` object. |
310 | 315 | :param int baudrate: SPI baudrate to use. Default is ``1000000``.
|
311 | 316 | :param int max_size: Size of FRAM in Bytes. Default is ``8192``.
|
312 | 317 | """
|
|
0 commit comments