{"id":34955746,"url":"https://github.com/ghosttypes/ff-5mp-api-py","last_synced_at":"2026-04-28T02:00:58.232Z","repository":{"id":322179031,"uuid":"994372957","full_name":"GhostTypes/ff-5mp-api-py","owner":"GhostTypes","description":"A comprehensive Python library for controlling FlashForge 3D printers","archived":false,"fork":false,"pushed_at":"2026-03-23T21:19:22.000Z","size":1607,"stargazers_count":4,"open_issues_count":0,"forks_count":1,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-03-24T19:45:53.643Z","etag":null,"topics":["flashforge","flashforge-5m"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/GhostTypes.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-06-01T19:52:07.000Z","updated_at":"2026-03-23T23:42:22.000Z","dependencies_parsed_at":"2026-01-20T04:03:39.583Z","dependency_job_id":null,"html_url":"https://github.com/GhostTypes/ff-5mp-api-py","commit_stats":null,"previous_names":["ghosttypes/ff-5mp-api-py"],"tags_count":8,"template":false,"template_full_name":null,"purl":"pkg:github/GhostTypes/ff-5mp-api-py","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GhostTypes%2Fff-5mp-api-py","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GhostTypes%2Fff-5mp-api-py/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GhostTypes%2Fff-5mp-api-py/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GhostTypes%2Fff-5mp-api-py/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/GhostTypes","download_url":"https://codeload.github.com/GhostTypes/ff-5mp-api-py/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GhostTypes%2Fff-5mp-api-py/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32362782,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-27T20:07:02.737Z","status":"online","status_checked_at":"2026-04-28T02:00:07.250Z","response_time":56,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["flashforge","flashforge-5m"],"created_at":"2025-12-26T22:01:53.091Z","updated_at":"2026-04-28T02:00:58.224Z","avatar_url":"https://github.com/GhostTypes.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# FlashForge Python API\n\nPython library for controlling FlashForge 3D printers with async support for the modern HTTP API and the legacy TCP protocol.\n\n## Supported Printers\n\n| Printer | Support |\n| --- | --- |\n| Adventurer 5M | Full |\n| Adventurer 5M Pro | Full |\n| AD5X | Full |\n| Adventurer 3 / 4 | Dedicated TCP clients |\n\n## Installation\n\n```bash\npip install flashforge-python-api\n```\n\n## Quick Start\n\nModern LAN-mode HTTP printers require:\n\n- printer IP address\n- serial number\n- check code (per-printer credential, not returned by discovery)\n\n```python\nimport asyncio\nimport os\nfrom flashforge import FlashForgeClient, FiveMClientConnectionOptions, PrinterDiscovery\n\n\nasync def main():\n    check_code = os.getenv(\"FLASHFORGE_CHECK_CODE\", \"\").strip()\n    if not check_code:\n        print(\"Set FLASHFORGE_CHECK_CODE before running this example\")\n        return\n\n    discovery = PrinterDiscovery()\n    printers = await discovery.discover()\n\n    if not printers:\n        print(\"No printers found\")\n        return\n\n    printer = printers[0]\n    if not printer.serial_number:\n        print(\"Discovered printer did not report a serial number\")\n        return\n\n    options = FiveMClientConnectionOptions(\n        http_port=printer.event_port,\n        tcp_port=printer.command_port,\n    )\n\n    async with FlashForgeClient(\n        printer.ip_address,\n        printer.serial_number,\n        check_code,\n        options=options,\n    ) as client:\n        status = await client.get_printer_status()\n        if not status:\n            return\n\n        await client.init_control()\n\n        status = await client.get_printer_status()\n        print(f\"Printer: {client.printer_name}\")\n        print(f\"State: {status.machine_state if status else 'unknown'}\")\n\n        await client.control.home_axes()\n\n\nasyncio.run(main())\n```\n\n## Main Entry Points\n\n- `FlashForgeClient`: primary client for modern printers\n- `PrinterDiscovery`: recommended discovery API\n- `FlashForgeA4Client`: documented TCP client for Adventurer 4 Lite / Pro printers\n- `FlashForgeA3Client`: documented TCP client for Adventurer 3 printers\n- `FlashForgeTcpClient` and `client.tcp_client`: lower-level TCP access for direct commands and generic legacy workflows\n\n## Capabilities\n\n- printer discovery\n- printer status and machine information\n- job control\n- file listing, uploads, and thumbnails\n- temperature and motion control\n- LED, camera, and filtration control where supported\n- AD5X-specific job and material-station support\n\n## Documentation\n\n- [docs/README.md](docs/README.md)\n- [docs/client.md](docs/client.md)\n- [docs/protocols.md](docs/protocols.md)\n- [docs/api_reference.md](docs/api_reference.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fghosttypes%2Fff-5mp-api-py","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fghosttypes%2Fff-5mp-api-py","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fghosttypes%2Fff-5mp-api-py/lists"}