Skip to content

Commit 7c40995

Browse files
jonamatjonamat
committed
clarify readme
1 parent 37d8d37 commit 7c40995

File tree

1 file changed

+38
-38
lines changed

1 file changed

+38
-38
lines changed

‎README.md

+38-38
Original file line numberDiff line numberDiff line change
@@ -43,44 +43,44 @@ Modem(
4343

4444
| Method | Description |
4545
| --------------------------------------------- | ----------------------------------------------------------------------- |
46-
| `reconnect() -> str` | Reconnect to serial |
47-
| `close() -> str` | Close the serial connection |
48-
| *Hardware related methods* | |
49-
| `get_model_identification() -> str` | Get the model identification |
50-
| `get_manufacturer_identification() -> str` | Get the manufacturer identification |
51-
| `get_serial_number() -> str` | Get the serial number |
52-
| `get_firmware_version() -> str` | Get the firmware version |
53-
| `get_volume() -> str` | Get the volume. The volume range is between 0 and 5 |
54-
| `set_volume(index: int) # 0-5` | Set the volume. The volume range must be between 0 and 5 |
55-
| `improve_tdd() -> str` | Decrease TDD Noise effect |
56-
| `enable_echo_suppression() -> str` | Enable echo suppression |
57-
| `disable_echo_suppression() -> str` | Disable echo suppression |
58-
| *Network related methods* | |
59-
| `get_network_registration_status() -> str` | Get the network registration status |
60-
| `get_network_mode() -> NetworkMode` | Get the network mode |
61-
| `get_network_name() -> str` | Get the network name |
62-
| `get_network_operator() -> str` | Get the network operator |
63-
| `get_signal_quality() -> str` | Get the signal quality |
64-
| `get_signal_quality_db() -> int` | Get the signal quality in dB |
65-
| `get_signal_quality_range() -> SignalQuality` | Get the signal quality as a range (see [SignalQuality](#SignalQuality)) |
66-
| `get_phone_number() -> str` | Get the phone number |
67-
| `get_sim_status() -> str` | Get the SIM status |
68-
| `set_network_mode(mode: NetworkMode) -> str` | Set the network mode |
69-
| *Calls related methods* | |
70-
| `call(number: str) -> str` | Call a number |
71-
| `answer() -> str` | Answer a call |
72-
| `hangup() -> str` | Hangup a call |
73-
| *SMS related methods* | |
74-
| `get_sms_list() -> list` | Get the list of SMS |
75-
| `empty_sms() -> str` | Empty the SMS storage |
76-
| `send_sms(number: str, message: str) -> str` | Send an SMS |
77-
| `get_sms(index: int) -> dict` | Get an SMS by ID |
78-
| `delete_sms(index: int) -> str` | Delete an SMS by ID |
79-
| *GPS related methods* | |
80-
| `get_gps_status() -> str` | Get the GPS status |
81-
| `start_gps() -> str` | Start the GPS |
82-
| `stop_gps() -> str` | Stop the GPS |
83-
| `get_gps_coordinates() -> dict` | Get the GPS coordinates |
46+
| reconnect() -> str | Reconnect to serial |
47+
| close() -> str | Close the serial connection |
48+
| ***Hardware related methods*** | |
49+
| get_model_identification() -> str | Get the model identification |
50+
| get_manufacturer_identification() -> str | Get the manufacturer identification |
51+
| get_serial_number() -> str | Get the serial number |
52+
| get_firmware_version() -> str | Get the firmware version |
53+
| get_volume() -> str | Get the volume. The volume range is between 0 and 5 |
54+
| set_volume(index: int) # 0-5 | Set the volume. The volume must be between 0 and 5 |
55+
| improve_tdd() -> str | Decrease TDD Noise effect |
56+
| enable_echo_suppression() -> str | Enable echo suppression |
57+
| disable_echo_suppression() -> str | Disable echo suppression |
58+
| ***Network related methods*** | |
59+
| get_network_registration_status() -> str | Get the network registration status |
60+
| get_network_mode() -> NetworkMode | Get the network mode |
61+
| get_network_name() -> str | Get the network name |
62+
| get_network_operator() -> str | Get the network operator |
63+
| get_signal_quality() -> str | Get the signal quality |
64+
| get_signal_quality_db() -> int | Get the signal quality in dB |
65+
| get_signal_quality_range() -> SignalQuality | Get the signal quality as a range (see [SignalQuality](#SignalQuality)) |
66+
| get_phone_number() -> str | Get the phone number |
67+
| get_sim_status() -> str | Get the SIM status |
68+
| set_network_mode(mode: NetworkMode) -> str | Set the network mode |
69+
| ***Calls related methods*** | |
70+
| call(number: str) -> str | Call a number |
71+
| answer() -> str | Answer a call |
72+
| hangup() -> str | Hangup a call |
73+
| ***SMS related methods*** | |
74+
| get_sms_list() -> list | Get the list of SMS |
75+
| empty_sms() -> str | Empty the SMS storage |
76+
| send_sms(number: str, message: str) -> str | Send an SMS |
77+
| get_sms(index: int) -> dict | Get an SMS by ID |
78+
| delete_sms(index: int) -> str | Delete an SMS by ID |
79+
| ***GPS related methods*** | |
80+
| get_gps_status() -> str | Get the GPS status |
81+
| start_gps() -> str | Start the GPS |
82+
| stop_gps() -> str | Stop the GPS |
83+
| get_gps_coordinates() -> dict | Get the GPS coordinates |
8484

8585

8686
### SignalQuality (enum)

0 commit comments

Comments
 (0)