Exiles on 1.1

.env

@@ -0,0 +1,3 @@
+FLASK_HOST=127.0.0.1
+FLASK_PORT=4470
+ANKERCTL_DATA=ankerctl_vol

.github/workflows/build-and-publish.yml

@@ -4,6 +4,9 @@ on:
   push:
     tags:
      - v**
+    branches:
+      - 'upcoming/*'
+      - 'master'
   pull_request:
     branches: [ master ]
 
@@ -48,8 +51,12 @@ jobs:
       with:
         images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
         flavor: |
-          latest=${{ github.event_name == 'push' }}
-        tags: ${{ github.ref_name }}
+          latest=${{ github.ref == 'refs/heads/master' }}
+        tags: |
+          type=raw,value=latest,enable=${{ github.ref == 'refs/heads/master' }}
+          type=edge,value=edge,enable=${{ startsWith(github.ref, 'refs/heads/upcoming/') }}
+          type=raw,value=upcoming,enable=${{ startsWith(github.ref, 'refs/heads/upcoming/') }}
+          type=ref,event=tag
 
     - name: Build and push Docker images
       uses: docker/[email protected]
@@ -87,4 +94,3 @@ jobs:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       with:
         args: release/ankerctl*
-

.gitignore

@@ -2,3 +2,4 @@
 __pycache__
 .DS_Store
 /settings.json
+.idea/

CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.0.1] - 2024-01-15
+
+ - Fixes MQTT connection errors post AnkerMake Firmware Upgrades
+
 ## [1.0.0] - 2023-05-24
 
  - Version 1.0.0!

Dockerfile.runtime

@@ -0,0 +1,34 @@
+# Second stage: runtime environment
+FROM python:3.11-slim
+
+# Copy the requirements file
+COPY requirements.txt .
+
+# Disable warning about running as "root"
+ENV PIP_ROOT_USER_ACTION=ignore
+
+# Disable caching - we just want the output
+ENV PIP_NO_CACHE_DIR=1
+
+# Install the dependencies
+RUN pip install --upgrade pip && \
+    pip install -r requirements.txt
+
+
+# Set the working directory to /app
+WORKDIR /app
+
+RUN mkdir -p /root/.config/
+
+# Copy the script and libraries
+COPY ankerctl.py /app/
+COPY web /app/web/
+COPY ssl /app/ssl/
+COPY static /app/static/
+COPY libflagship /app/libflagship/
+COPY cli /app/cli/
+
+STOPSIGNAL SIGINT
+
+ENTRYPOINT ["/app/ankerctl.py"]
+CMD ["webserver", "run"]

README.md

@@ -1,10 +1,10 @@
 # AnkerMake M5 Protocol
 
-Welcome! This repository contains `ankerctl`, a command-line interface and web UI for monitoring, controlling and interfacing with AnkerMake M5 3D printers.
+Welcome! This repository contains `ankerctl`, a command-line interface and web UI for monitoring, controlling and interfacing with AnkerMake M5 and M5C 3D printers.
 
 **NOTE:** This is our first major release and while we have tested thoroughly there may be bugs. If you encounter one please open a [Github Issue](https://github.com/Ankermgmt/ankermake-m5-protocol/issues/new/choose)
 
-The `ankerctl` program uses [`libflagship`](documentation/developer-docs/libflagship.md), a library for communicating with the numerous different protocols required for connecting to an AnkerMake M5 printer. The `libflagship` library is also maintained in this repo, under [`libflagship/`](libflagship/).
+The `ankerctl` program uses [`libflagship`](documentation/developer-docs/libflagship.md), a library for communicating with the numerous different protocols required for connecting to an AnkerMake M5 or M5C printer. The `libflagship` library is also maintained in this repo, under [`libflagship/`](libflagship/).
 
 ![Screenshot of ankerctl](/documentation/web-interface.png "Screenshot of ankerctl web interface")
 
@@ -14,15 +14,15 @@ The `ankerctl` program uses [`libflagship`](documentation/developer-docs/libflag
 
  - Print directly from PrusaSlicer and its derivatives (SuperSlicer, Bamboo Studio, OrcaSlicer, etc.)
 
- - Connect to AnkerMake M5 and AnkerMake APIs without using closed-source Anker software.
+ - Connect to AnkerMake M5/M5C and AnkerMake APIs without using closed-source Anker software.
 
  - Send raw gcode commands to the printer (and see the response).
 
  - Low-level access to MQTT, PPPP and HTTPS APIs.
 
  - Send print jobs (gcode files) to the printer.
 
- - Stream camera image/video to your computer.
+ - Stream camera image/video to your computer (AnkerMake M5 only).
 
  - Easily monitor print status.
 
@@ -177,7 +177,7 @@ Some examples:
 
 This project is **<u>NOT</u>** endorsed, affiliated with, or supported by AnkerMake. All information found herein is gathered entirely from reverse engineering using publicly available knowledge and resources.
 
-The goal of this project is to make the AnkerMake M5 usable and accessible using only Free and Open Source Software (FOSS).
+The goal of this project is to make the AnkerMake M5 and M5C usable and accessible using only Free and Open Source Software (FOSS).
 
 This project is [licensed under the GNU GPLv3](LICENSE), and copyright © 2023 Christian Iversen.
 

ankerctl.py

@@ -3,6 +3,8 @@
 import json
 import click
 import platform
+import getpass
+import webbrowser
 import logging as log
 from os import path, environ
 from rich import print  # you need python3
@@ -15,17 +17,23 @@
 import cli.util
 import cli.pppp
 import cli.checkver  # check python version
+import cli.countrycodes
 
 import libflagship.httpapi
 import libflagship.logincache
 import libflagship.seccode
 
 from libflagship.util import enhex
 from libflagship.mqtt import MqttMsgType
-from libflagship.pppp import PktLanSearch, P2PCmdType, P2PSubCmdType, FileTransfer
+from libflagship.pppp import P2PCmdType, P2PSubCmdType, FileTransfer
 from libflagship.ppppapi import FileUploadInfo, PPPPError
 
 
+from dotenv import load_dotenv
+
+load_dotenv()  # take environment variables from .env.
+
+
 class Environment:
     def __init__(self):
         pass
@@ -214,22 +222,26 @@ def pppp(): pass
 
 
 @pppp.command("lan-search")
+@click.option("--store", "-s", is_flag=True, help="Store found IP address(es) in configuration file")
 @pass_env
-def pppp_lan_search(env):
+def pppp_lan_search(env, store):
     """
     Attempt to find available printers on local LAN.
 
     Works by broadcasting a LAN_SEARCH packet, and waiting for a reply.
     """
-    api = cli.pppp.pppp_open_broadcast(dumpfile=env.pppp_dump)
-    try:
-        api.send(PktLanSearch())
-        resp = api.recv(timeout=1.0)
-    except TimeoutError:
+    found_printers = dict()
+    for duid, ip in cli.pppp.pppp_find_printer_ip_addresses(dumpfile=env.pppp_dump):
+        log.info(f"Printer [{duid}] is online at {ip}")
+        found_printers[duid] = ip
+
+    if not found_printers:
         log.error("No printers responded within timeout. Are you connected to the same network as the printer?")
-    else:
-        if isinstance(resp, libflagship.pppp.PktPunchPkt):
-            log.info(f"Printer [{str(resp.duid)}] is online at {str(api.addr[0])}")
+
+    # if requested, update stored printer IP addresses
+    if store and found_printers:
+        log.info(f"Checking configured printer IP addresses:")
+        cli.config.update_printer_ip_addresses(env.config, found_printers)
 
 
 @pppp.command("print-file")
@@ -382,6 +394,82 @@ def config_decode(env, fd):
     print(json.dumps(cache, indent=4))
 
 
+@config.command("login")
+@click.argument("country", required=False, metavar="[COUNTRY (2 letter code)]")
+@click.argument("email", required=False)
+@click.argument("password", required=False)
+@pass_env
+def config_login(env, country, email, password):
+    """
+    Fetch configuration by logging in with provided credentials.
+    """
+
+    try:
+        with env.config.open() as cfg:
+            if cfg.account:
+                if country is None and cfg.account.country:
+                    country = cfg.account.country
+                    log.info(f"Country: {country.upper()}")
+                if email is None:
+                    email = cfg.account.email
+                    log.info(f"Email address: {email}")
+    except KeyError:
+        pass
+
+    # interactive user input (only if arguments not given on command line)
+    if email is None:
+        email = input("Please enter your email address: ").strip()
+
+    if password is None:
+        password = getpass.getpass("Please enter your password: ")
+
+    if country:
+        country = country.upper()
+    while not cli.countrycodes.code_to_country(country):
+        country = input("Please enter your country (2 digit code): ").strip().upper()
+
+    region = libflagship.logincache.guess_region(country)
+    login = None
+    tries = 3
+    captcha = {"id": None, "answer": None}
+    # retry until login was successful
+    while not login and tries > 0:
+        tries -= 1
+        try:
+            login = cli.config.fetch_config_by_login(email, password, region, env.insecure,
+                                                     captcha_id=captcha["id"], captcha_answer=captcha["answer"])
+            break
+        except libflagship.httpapi.APIError as E:
+            # check if the error is actually a request to solve a captcha
+            if E.json and "data" in E.json:
+                data = E.json["data"]
+                if "captcha_id" in data:
+                    captcha = {
+                        "id": data["captcha_id"],
+                        "img": data["item"]
+                    }
+
+        # ask the user to resolve the captcha
+        if captcha["id"]:
+            log.warning(f"Login requires solving a captcha")
+            if webbrowser.open(captcha["img"], new=2):
+                captcha["answer"] = input("Please enter the captcha answer: ").strip()
+            else:
+                log.critical(f"Cannot open webbrowser for displaying captcha, aborting.")
+                tries = 0
+        else:
+            log.critical(f"Unknown login error: {E}")
+            tries = 0
+
+    if login:
+        log.info(f"Login successful, importing configuration from server..")
+
+        # load remaining configuration items from the server
+        cli.config.import_config_from_server(env.config, login, env.insecure)
+
+        log.info("Finished import")
+
+
 @config.command("import")
 @click.argument("fd", required=False, type=click.File("r"), metavar="path/to/login.json")
 @pass_env
@@ -415,23 +503,11 @@ def config_import(env, fd):
 
     log.info("Loading cache..")
 
-    # extract auth token
+    # load the login configuration from the provided file
     cache = libflagship.logincache.load(fd.read())["data"]
-    auth_token = cache["auth_token"]
-
-    # extract account region
-    region = libflagship.logincache.guess_region(cache["ab_code"])
-
-    try:
-        config = cli.config.load_config_from_api(auth_token, region, env.insecure)
-    except libflagship.httpapi.APIError as E:
-        log.critical(f"Config import failed: {E} "
-                    "(auth token might be expired: make sure Ankermake Slicer can connect, then try again)")
-    except Exception as E:
-        log.critical(f"Config import failed: {E}")
 
-    # save config to json file named `ankerctl/default.json`
-    env.config.save("default", config)
+    # import the remaining configuration from the server
+    cli.config.import_config_from_server(env.config, cache, env.insecure)
 
     log.info("Finished import")
 
@@ -455,6 +531,7 @@ def config_show(env):
         print(f"    auth_token: {cfg.account.auth_token[:10]}...<REDACTED>")
         print(f"    email:      {cfg.account.email}")
         print(f"    region:     {cfg.account.region.upper()}")
+        print(f"    country:    {'<REDACTED>' if cfg.account.country else ''}")
         print()
 
         log.info("Printers:")

build-exe.bat

@@ -0,0 +1 @@
+pyinstaller -F --add-data templates:templates --add-data web:web --add-data static:static --add-data ssl:ssl --add-data cli:cli --add-data libflagship:libflagship --add-data specification:specification  --icon .\packaging\logo.ico .\ankerctl.py