diff --git a/adafruit_fona/adafruit_fona.py b/adafruit_fona/adafruit_fona.py index 1e88937..fc838fa 100644 --- a/adafruit_fona/adafruit_fona.py +++ b/adafruit_fona/adafruit_fona.py @@ -64,11 +64,11 @@ # pylint: disable=too-many-instance-attributes, too-many-public-methods class FONA: """CircuitPython FONA module interface. - :param ~busio.uart UART: FONA UART connection. - :param ~digialio RST: FONA RST pin. - :param ~digialio RI: Optional FONA Ring Interrupt (RI) pin. - :param bool debug: Enable debugging output. + :param ~busio.UART uart: FONA UART connection. + :param ~digitalio.DigitalInOut rdt: FONA RST pin. + :param ~digitalio.DigitalInOut ri: Optional FONA Ring Interrupt (RI) pin. + :param bool debug: Enable debugging output. """ TCP_MODE = const(0) # TCP socket @@ -442,9 +442,8 @@ def receive_sms(self) -> Tuple[str, str]: """Checks for a message notification from the FONA module, replies back with the a tuple containing (sender, message). - NOTE: This method needs to be polled consistently due to the lack - of hw-based interrupts in CircuitPython. - + :note: This method needs to be polled consistently due to the lack + of hw-based interrupts in CircuitPython. """ if self._ri is not None: # poll the RI pin if self._ri.value: diff --git a/adafruit_fona/adafruit_fona_network.py b/adafruit_fona/adafruit_fona_network.py index 30cf38a..c002f7d 100755 --- a/adafruit_fona/adafruit_fona_network.py +++ b/adafruit_fona/adafruit_fona_network.py @@ -28,17 +28,16 @@ class CELLULAR: - """Interface for connecting to and interacting with GSM and CDMA cellular networks.""" + """Interface for connecting to and interacting with GSM and CDMA cellular networks. + + :param FONA fona: The Adafruit FONA module we are using. + :param tuple apn: Tuple containing APN name, (optional) APN username, + and APN password. + """ def __init__( self, fona: FONA, apn: Tuple[str, Optional[str], Optional[str]] ) -> None: - """Initializes interface with cellular network. - - :param FONA fona: The Adafruit FONA module we are using. - :param tuple apn: Tuple containing APN name, (optional) APN username, - and APN password. - """ self._iface = fona self._apn = apn self._network_connected = False diff --git a/adafruit_fona/fona_3g.py b/adafruit_fona/fona_3g.py index c9acce5..eedad3e 100755 --- a/adafruit_fona/fona_3g.py +++ b/adafruit_fona/fona_3g.py @@ -4,8 +4,7 @@ # SPDX-License-Identifier: MIT """ -:py:class:`~adafruit_fona.fona_3g.FONA3G` -`adafruit_fona_3g` +`fona_3g` ================================================================================ FONA3G cellular module instance. @@ -40,9 +39,9 @@ class FONA3G(FONA): """FONA 3G module interface. - :param ~busio.uart uart: FONA UART connection. - :param ~DigitalInOut rst: FONA RST pin. - :param ~DigitalInOut ri: Optional FONA Ring Interrupt (RI) pin. + :param ~busio.UART uart: FONA UART connection. + :param ~digitalio.DigitalInOut rst: FONA RST pin. + :param ~digitalio.DigitalInOut ri: Optional FONA Ring Interrupt (RI) pin. :param bool debug: Enable debugging output. """ diff --git a/docs/api.rst b/docs/api.rst index 280ec86..7846032 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -9,3 +9,9 @@ .. automodule:: adafruit_fona.adafruit_fona_socket :members: + +.. automodule:: adafruit_fona.adafruit_fona_network + :members: + +.. automodule:: adafruit_fona.fona_3g + :members: