Skip to content

Commit fb2b58d

Browse files
authored
Remove unused Enums and improve documentation (#10)
1 parent 08c689c commit fb2b58d

File tree

2 files changed

+17
-16
lines changed

2 files changed

+17
-16
lines changed

README.md

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -15,19 +15,19 @@ Python 3.7+ required.
1515

1616
The Sagemcom F@st series is used by multiple cable companies, where some cable companies did rebrand the router. Examples are the b-box from Proximus, Home Hub from bell and the Smart Hub from BT.
1717

18-
| Router Model | Provider(s) | Authentication Method |
19-
| -------------------- | -------------------- | --------------------- |
20-
| Sagemcom F@st 3864 | Optus | sha512 |
21-
| Sagemcom F@st 3865b | Proximus (b-box3) | md5 |
22-
| Sagemcom F@st 3890V3 | Delta / Zeelandnet | md5 |
23-
| Sagemcom F@st 4360Air| KPN | md5 |
24-
| Sagemcom F@st 5250 | Bell (Home Hub 2000) | md5 |
25-
| Sagemcom F@st 5280 | | sha512 |
26-
| Sagemcom F@st 5364 | BT (Smart Hub) | md5 |
27-
| Sagemcom F@st 5370e | Telia | sha512 |
28-
| Sagemcom F@st 5566 | Bell (Home Hub 3000) | md5 |
29-
| Sagemcom F@st 5655V2 | MásMóvil | md5 |
30-
| Speedport Pro | Telekom | md5 |
18+
| Router Model | Provider(s) | Authentication Method | Comments |
19+
| --------------------- | -------------------- | --------------------- | ----------------------------- |
20+
| Sagemcom F@st 3864 | Optus | sha512 | username: guest, password: "" |
21+
| Sagemcom F@st 3865b | Proximus (b-box3) | md5 | |
22+
| Sagemcom F@st 3890V3 | Delta / Zeelandnet | md5 | |
23+
| Sagemcom F@st 4360Air | KPN | md5 | |
24+
| Sagemcom F@st 5250 | Bell (Home Hub 2000) | md5 | username: guest, password: "" |
25+
| Sagemcom F@st 5280 | | sha512 | |
26+
| Sagemcom F@st 5364 | BT (Smart Hub) | md5 | username: guest, password: "" |
27+
| Sagemcom F@st 5370e | Telia | sha512 | |
28+
| Sagemcom F@st 5566 | Bell (Home Hub 3000) | md5 | username: guest, password: "" |
29+
| Sagemcom F@st 5655V2 | MásMóvil | md5 | |
30+
| Speedport Pro | Telekom | md5 | |
3131

3232
> Contributions welcome. If you router model is supported by this package, but not in the list above, please create [an issue](https://github.com/iMicknl/python-sagemcom-api/issues/new) or pull request.
3333
@@ -96,9 +96,11 @@ asyncio.run(main())
9696
## Advanced
9797

9898
### Determine the EncryptionMethod
99+
99100
(not supported yet)
100101

101102
### Handle exceptions
103+
102104
Some functions may cause an error when an attempt is made to execute it. These exceptions are thrown by the client and need to be [handled in your Python program](https://docs.python.org/3/tutorial/errors.html#handling-exceptions). Best practice is to catch some specific exceptions and handle them gracefully.
103105

104106
```python
@@ -123,7 +125,7 @@ except Exception as exception:
123125
print(exception)
124126
```
125127

126-
### Use your own aiohttp ClientSession
128+
### Use your own aiohttp ClientSession
127129

128130
> ClientSession is the heart and the main entry point for all client API operations. The session contains a cookie storage and connection pool, thus cookies and connections are shared between HTTP requests sent by the same session.
129131
@@ -136,7 +138,6 @@ session = ClientSession(timeout=ClientTimeout(100))
136138
client = SagemcomClient(session=session)
137139
```
138140

139-
140141
## Inspired by
141142

142143
- [wuseman/SAGEMCOM-FAST-5370e-TELIA](https://github.com/wuseman/SAGEMCOM-FAST-5370e-TELIA)

sagemcom_api/client.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ def __init__(
4747
host,
4848
username,
4949
password,
50-
authentication_method=EncryptionMethod.UNKNOWN,
50+
authentication_method,
5151
session: ClientSession = None,
5252
):
5353
"""

0 commit comments

Comments
 (0)