Skip to content

Commit

Permalink
Various maintenance updates (package updates, readme updates) (#334)
Browse files Browse the repository at this point in the history 
This pull request includes several updates to improve the development
environment, update dependencies, and enhance documentation. The most
important changes are listed below:

### Development Environment:

*
[`.devcontainer/devcontainer.json`](diffhunk://#diff-24ad71c8613ddcf6fd23818cb3bb477a1fb6d83af4550b0bad43099813088686L20-R21):
Added the `yzhang.markdown-all-in-one` extension to the VSCode
customizations.

### Dependency Updates:

*
[`.pre-commit-config.yaml`](diffhunk://#diff-63a9c44a44acf85fea213a857769990937107cf072831e1a26808cfde9d096b9L3-R3):
Updated the `pre-commit-hooks` repository version from `v4.0.1` to
`v4.6.0`.

### Documentation Enhancements:

*
[`README.md`](diffhunk://#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5L19-R23):
Fixed table formatting and updated comments for several router models.
[[1]](diffhunk://#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5L19-R23)
[[2]](diffhunk://#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R38-R39)
*
[`README.md`](diffhunk://#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R163-R168):
Added a new section for debugging common issues with a link to advanced
instructions.
  • Loading branch information
@iMicknl
iMicknl authored Aug 9, 2024
1 parent d44ab7d commit 6cf2723
Show file tree
Hide file tree
Showing 4 changed files with 133 additions and 122 deletions.
7 changes: 4 additions & 3 deletions .devcontainer/devcontainer.json
View file
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
// For format details, see https://aka.ms/devcontainer.json. For config options, see the
// README at: https://github.com/devcontainers/templates/tree/main/src/python
{
"name": "python-sagemcom-api (Python 11)",
"name": "python-sagemcom-api (Python 12)",
// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
"image": "mcr.microsoft.com/devcontainers/python:0-3.11",
"image": "mcr.microsoft.com/devcontainers/python:1-3.12-bullseye",
// Features to add to the dev container. More info: https://containers.dev/features.
"features": {
"ghcr.io/devcontainers/features/github-cli:1": {},
Expand All @@ -17,7 +17,8 @@
"customizations": {
"vscode": {
"extensions": [
"ms-python.python"
"ms-python.python",
"yzhang.markdown-all-in-one"
],
"settings": {
"python.defaultInterpreterPath": "./.venv/bin/python"
Expand Down
2 changes: 1 addition & 1 deletion .pre-commit-config.yaml
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.0.1
rev: v4.6.0
hooks:
- id: check-json
exclude: .devcontainer
Expand Down
54 changes: 31 additions & 23 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,29 +15,31 @@ Python 3.9+ required.

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.

| Router Model | Provider(s) | Authentication Method | Comments |
| --------------------- | -------------------- | --------------------- | ----------------------------- |
| Sagemcom F@st 3864 | Optus | sha512 | username: guest, password: "" |
| Sagemcom F@st 3865b | Proximus (b-box3) | md5 | |
| Sagemcom F@st 3890V3 | Delta / Zeelandnet | sha512 | |
| Sagemcom F@st 3890V3 | DNA (DNA Mesh Wifi F-3890) | sha512 | "Not allowed to set AdvancedMode parameter on your device", username: admin |
| Sagemcom F@st 3896 | | sha512 | username: admin |
| Sagemcom F@st 4360Air | KPN | md5 | |
| Sagemcom F@st 4353 | Belong Gateway | md5 | username: admin, password: "" |
| Sagemcom F@st 5250 | Bell (Home Hub 2000) | md5 | username: guest, password: "" |
| Sagemcom F@st 5280 | | sha512 | |
| Sagemcom F@st 5290 / FWR226e | Frontier | md5 | username: admin |
| Sagemcom F@st 5359 | KPN (Box 12) | sha512 | username: admin |
| Sagemcom F@st 5364 | BT (Smart Hub) | md5 | username: guest, password: "" |
| SagemCom F@st 5366SD | Eir F3000 | md5 | |
| Sagemcom F@st 5370e | Telia | sha512 | |
| Sagemcom F@st 5380 | TDC | md5 | |
| Sagemcom F@st 5566 | Bell (Home Hub 3000) | md5 | username: guest, password: "" |
| Sagemcom F@st 5688T | Salt (FibreBox_X6) | sha512 | username: admin |
| Sagemcom F@st 5689 | Bell (Home Hub 4000) | md5 | username: admin, password: "" |
| Sagemcom F@st 5655V2 | MásMóvil | md5 | |
| Sagemcom F@st 5657IL | | md5 | |
| Speedport Pro | Telekom | md5 | username: admin |
| Router Model | Provider(s) | Authentication Method | Comments |
| ---------------------------- | -------------------------- | --------------------- | ----------------------------- |
| Sagemcom F@st 3864 | Optus | sha512 | username: guest, password: "" |
| Sagemcom F@st 3865b | Proximus (b-box3) | md5 | |
| Sagemcom F@st 3890V3 | Delta / Zeelandnet | sha512 | |
| Sagemcom F@st 3890V3 | DNA (DNA Mesh Wifi F-3890) | sha512 | username: admin |
| Sagemcom F@st 3896 | | sha512 | username: admin |
| Sagemcom F@st 4360Air | KPN | md5 | |
| Sagemcom F@st 4353 | Belong Gateway | md5 | username: admin, password: "" |
| Sagemcom F@st 5250 | Bell (Home Hub 2000) | md5 | username: guest, password: "" |
| Sagemcom F@st 5280 | | sha512 | |
| Sagemcom F@st 5290 / FWR226e | Frontier | md5 | username: admin |
| Sagemcom F@st 5359 | KPN (Box 12) | sha512 | username: admin |
| Sagemcom F@st 5364 | BT (Smart Hub) | md5 | username: guest, password: "" |
| SagemCom F@st 5366SD | Eir F3000 | md5 | |
| Sagemcom F@st 5370e | Telia | sha512 | |
| Sagemcom F@st 5380 | TDC | md5 | |
| Sagemcom F@st 5566 | Bell (Home Hub 3000) | md5 | username: guest, password: "" |
| Sagemcom F@st 5688T | Salt (FibreBox_X6) | sha512 | username: admin |
| Sagemcom F@st 5689 | Bell (Home Hub 4000) | md5 | username: admin, password: "" |
| Sagemcom F@st 5689E | Bell (Giga Hub) | sha512 | username: admin, password: "" |
| Sagemcom F@st 5690 | Bell (Giga Hub) | sha512 | username: admin, password: "" |
| Sagemcom F@st 5655V2 | MásMóvil | md5 | |
| Sagemcom F@st 5657IL | | md5 | |
| Speedport Pro | Telekom | md5 | username: admin |

> 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.
Expand Down Expand Up @@ -158,6 +160,12 @@ session = ClientSession(timeout=ClientTimeout(100))
client = SagemcomClient(session=session)
```

### Debugging

- Unable to login (XMO_AUTHENTICATION_ERR)

See [advanced instructions for debugging](docs/debugging.md) common issues.

## Inspired by

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

0 comments on commit 6cf2723

Please sign in to comment.