Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

ASCII animation for the "watch" command and discovered a new PrintInfoStatus #6

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
+415 −16
Open

ASCII animation for the "watch" command and discovered a new PrintInfoStatus #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
083b61f
Made some little animations to go along with the status changes
rorosentrater Dec 9, 2023
7ef0afe
With the switch to enums we need to get the actual int value before d…
rorosentrater Dec 11, 2023
74b0941
Merge branch 'send_command_enum_fix' into animations
rorosentrater Dec 11, 2023
34e56cd
changed watch command to only break when COMPLETE status is reported.…
rorosentrater Dec 12, 2023
538a96d
made ASCII animations optional with new --no-animation arg
rorosentrater Dec 12, 2023
16fcf93
updated command examples in README. Also formatted some of the exampl…
rorosentrater Dec 12, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
96 changes: 86 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,15 +23,19 @@ install the `alive-progress` package for nicer progress bars (`pip3 install aliv

```
$ ./cassini.py status
192.168.7.128: Saturn3Ultra (ELEGOO Saturn 3 Ultra) Status: 1
Print Status: 2 Layers: 19/130
File Transfer Status: 0
192.168.1.15:
Saturn3Ultra (ELEGOO Saturn 3 Ultra)
Machine Status: READY
Print Status: COMPLETE
Layers: 500/500
File: _Magnet_holder.ctb
File Transfer Status: NONE
```

### Watch live print progress

```
$ ./cassini.py watch [interval]
$ ./cassini.py watch [interval] --no-animation
_STL_B_Warriors_1_Sword_Combined_Supported.goo |███████████████████████████████████▉ ︎ | 90%
```

Expand Down Expand Up @@ -126,11 +130,83 @@ The id is the `MainboardID` from the original discovery. Each payload

The printer publishes messages to three topics:

`/sdcp/status/ABCD1234ABCD1234`: Status messages, same format as the `"Status"` content of the broadcast message: `{"Id":"f25273b12b094c5a8b9513a30ca60049","Data":{"Status":{"CurrentStatus":0,"PreviousStatus":0,"PrintInfo":{"Status":0,"CurrentLayer":0,"TotalLayer":0,"CurrentTicks":0,"TotalTicks":0,"ErrorNumber":0,"Filename":""},"FileTransferInfo":{"Status":0,"DownloadOffset":0,"CheckOffset":0,"FileTotalSize":0,"Filename":""}},"MainboardID":"ABCD1234ABCD1234","TimeStamp":8629636}}`
`/sdcp/status/ABCD1234ABCD1234`: Status messages, same format as the `"Status"` content of the broadcast message:
```
{
"Id": "f25273b12b094c5a8b9513a30ca60049",
"Data": {
"Status": {
"CurrentStatus": 0,
"PreviousStatus": 0,
"PrintInfo": {
"Status": 0,
"CurrentLayer": 0,
"TotalLayer": 0,
"CurrentTicks": 0,
"TotalTicks": 0,
"ErrorNumber": 0,
"Filename": ""
},
"FileTransferInfo": {
"Status": 0,
"DownloadOffset": 0,
"CheckOffset": 0,
"FileTotalSize": 0,
"Filename": ""
}
},
"MainboardID": "ABCD1234ABCD1234",
"TimeStamp": 8629636
}
}
```

`/sdcp/attributes/ABCD1234ABCD1234`: Unclear what this is used for, as it seems to repeat the Status information: `{"Id":"f25273b12b094c5a8b9513a30ca60049","Data":{"Attributes":{"CurrentStatus":0,"PreviousStatus":0,"PrintInfo":{"Status":0,"CurrentLayer":0,"TotalLayer":0,"CurrentTicks":0,"TotalTicks":0,"ErrorNumber":0,"Filename":""},"FileTransferInfo":{"Status":0,"DownloadOffset":0,"CheckOffset":0,"FileTotalSize":0,"Filename":""}},"MainboardID":"ABCD1234ABCD1234","TimeStamp":8629737}}`
`/sdcp/attributes/ABCD1234ABCD1234`: Unclear what this is used for, as it seems to repeat the Status information:
```
{
"Id": "f25273b12b094c5a8b9513a30ca60049",
"Data": {
"Attributes": {
"CurrentStatus": 0,
"PreviousStatus": 0,
"PrintInfo": {
"Status": 0,
"CurrentLayer": 0,
"TotalLayer": 0,
"CurrentTicks": 0,
"TotalTicks": 0,
"ErrorNumber": 0,
"Filename": ""
},
"FileTransferInfo": {
"Status": 0,
"DownloadOffset": 0,
"CheckOffset": 0,
"FileTotalSize": 0,
"Filename": ""
}
},
"MainboardID": "ABCD1234ABCD1234",
"TimeStamp": 8629737
}
}
```

`/sdcp/response/ABCD1234ABCD1234`: Responses to `/sdcp/request/XXX` messages. The `Cmd` inside Data (if present) and `RequestID` values will match what was sent in the request. Example: `{"Id":"f25273b12b094c5a8b9513a30ca60049","Data":{"Cmd":1,"Data":{"Ack":0},"RequestID":"130fdded918e4276a47e504f554bed54","MainboardID":"ABCD1234ABCD1234","TimeStamp":8567213}}`
`/sdcp/response/ABCD1234ABCD1234`: Responses to `/sdcp/request/XXX` messages. The `Cmd` inside Data (if present) and `RequestID` values will match what was sent in the request. Example:
```
{
"Id": "f25273b12b094c5a8b9513a30ca60049",
"Data": {
"Cmd": 1,
"Data": {
"Ack": 0
},
"RequestID": "130fdded918e4276a47e504f554bed54",
"MainboardID": "ABCD1234ABCD1234",
"TimeStamp": 8567213
}
}
```

The printer subscribes to a request topic specific to its mainboard ID `/sdcp/request/ABCD1234ABCD1234`, with payloads looking like:

Expand Down Expand Up @@ -202,8 +278,8 @@ is connected to. The file needs to be accessible at the specified URL.
"TimeStamp": 1693671336846
},
"Id": "0a69ee780fbd40d7bfb95b312250bf46"
}```
}
```

The printer will set CurrentStatus = 2 (Busy), and FileTransferInfo.Status = 0 while the transfer is in progress,
and will give Status updates. When finished, CurrentStatus will return to 0, and FileTransferInfo will be either 2 (success)
or 3 (failure).
and will give Status updates. When finished, CurrentStatus will return to 0, and FileTransferInfo will be either 2 (success) or 3 (failure).
267 changes: 267 additions & 0 deletions ascii_art.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,267 @@

class PrinterArt:
unkown_ascii_art = [
"""
=====================================
|| ||
|| PRINTER ||
|| unknown status ||
=====================================
|| ||
|| ||
|| ??????????????? ||
|| ??????????????? ||
|| ??????????????? ||
|| ??????????????? ||
|| ??????????????? ||
|| ??????????????? ||
|| ??????????????? ||
|| ??????????????? ||
|| ??????????????? ||
|| ||
|| ||
-------------------------------------
|| ||
|| ||
|| ||
=====================================
"""
]
idle_ascii_art = [
"""
=====================================
|| ||
|| PRINTER ||
|| (IDLE) ||
=====================================
|| ||
|| ||
|| ||
|| ||
|| ||
|| ||
|| ||
|| ||
|| ||
|| ||
|| ||
|| ||
|| ||
-------------------------------------
|| ||
|| ||
|| ||
=====================================
"""
]
complete_ascii_art = [
"""
=====================================
|| ||
|| PRINTER ||
|| COMPLETE! ||
=====================================
|| | ||
|| | ||
|| | ||
|| --------------------------- ||
|| | | ||
|| --------------------------- ||
|| | | | | / | | ||
|| +-+ | |/ V ||
|| +----+ ||
||~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~||
|| ||
|| ||
|| ||
-------------------------------------
|| ||
|| ||
|| ||
=====================================
"""
]
# For lowering, exposure and retracting animation frames.
# Play in different order to simulate direction.
# Limit range in case printer remains in phase
print_cycle_ascii_art = [
# ⌄ Start Lowering... End Retract
"""
=====================================
|| ||
|| PRINTER ||
|| ||
=====================================
|| | ||
|| | ||
|| --------------------------- ||
|| | | ||
|| --------------------------- ||
|| ||
|| ||
|| ||
|| ||
||~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~||
|| ||
|| ||
|| ||
-------------------------------------
|| ||
|| ||
|| ||
=====================================
""",
"""
=====================================
|| ||
|| PRINTER ||
|| ||
=====================================
|| | ||
|| | ||
|| | ||
|| | ||
|| --------------------------- ||
|| | | ||
|| --------------------------- ||
|| ||
|| ||
||~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~||
|| ||
|| ||
|| ||
-------------------------------------
|| ||
|| ||
|| ||
=====================================
""",
"""
=====================================
|| ||
|| PRINTER ||
|| ||
=====================================
|| | ||
|| | ||
|| | ||
|| | ||
|| | ||
|| | ||
|| --------------------------- ||
|| | | ||
|| --------------------------- ||
||~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~||
|| ||
|| ||
|| ||
-------------------------------------
|| ||
|| ||
|| ||
=====================================
""",
"""
=====================================
|| ||
|| PRINTER ||
|| ||
=====================================
|| | ||
|| | ||
|| | ||
|| | ||
|| | ||
|| | ||
|| | ||
|| | ||
|| --------------------------- ||
||~~~| |~~~||
|| --------------------------- ||
|| ||
|| ||
-------------------------------------
|| ||
|| ||
|| ||
=====================================
""",
"""
=====================================
|| ||
|| PRINTER ||
|| ||
=====================================
|| | ||
|| | ||
|| | ||
|| | ||
|| | ||
|| | ||
|| | ||
|| | ||
|| | ||
||~~~---------------------------~~~||
|| | | ||
|| --------------------------- ||
|| ||
-------------------------------------
|| ||
|| ||
|| ||
=====================================
""",
# End Lowering...Begin Retract ^
# Start Exposure ⌄
"""
=====================================
|| ||
|| PRINTER ||
|| ||
=====================================
|| | ||
|| | ||
|| | ||
|| | ||
|| | ||
|| | ||
|| | ||
|| | ||
|| | ||
||~~~---------------------------~~~||
|| | | ||
|| --------------------------- ||
|| \ | / ||
-------------------------------------
|| \ | / ||
|| \ | / ||
|| \|/ ||
==================0==================
""",
"""
=====================================
|| ||
|| PRINTER ||
|| ||
=====================================
|| | ||
|| | ||
|| | ||
|| | ||
|| | ||
|| | ||
|| | ||
|| | ||
|| | ||
||~~~---------------------------~~~||
|| | | ||
|| --------------------------- ||
|| \ | / ||
--------------\---|---/--------------
|| \ | / ||
|| \ | / ||
|| \|/ ||
==================0==================
"""
# End Exposure
]
Loading