https://github.com/leandro-bertoluzzi/remote-cnc-api
Web API to monitor and manage a GRBL-based CNC machine
https://github.com/leandro-bertoluzzi/remote-cnc-api
alembic cnc-controller docker docker-compose flask mysql-database python raspberry-pi
Last synced: 3 months ago
JSON representation
Web API to monitor and manage a GRBL-based CNC machine
- Host: GitHub
- URL: https://github.com/leandro-bertoluzzi/remote-cnc-api
- Owner: Leandro-Bertoluzzi
- License: mit
- Created: 2023-04-23T01:17:57.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2024-05-22T22:07:21.000Z (about 1 year ago)
- Last Synced: 2024-05-22T23:24:57.967Z (about 1 year ago)
- Topics: alembic, cnc-controller, docker, docker-compose, flask, mysql-database, python, raspberry-pi
- Language: Python
- Homepage:
- Size: 119 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
Remote CNC API
🚧 Remote CNC API 🚀 Under construction... 🚧
About  | Â
Features  | Â
Technologies  | Â
Requirements  | Â
Starting  | Â
Access outside local intranet  | Â
License  | Â
Authors
## :warning: Notice
**ARCHIVED** -- This repo is not longer being maintained and its content was moved [here](https://github.com/Leandro-Bertoluzzi/remote-cnc).
## :dart: About
API to monitor and manage an Arduino-based CNC machine.
## :sparkles: Features
:heavy_check_mark: G-code files management\
:heavy_check_mark: Real time monitoring of CNC status\
:heavy_check_mark: Tasks management and scheduling
## :rocket: Technologies
The following tools were used in this project:
- [Python](https://www.python.org/)
- [FastAPI](https://fastapi.tiangolo.com/)
- [PostgreSQL](https://www.postgresql.org/)
- [SQLAlchemy](https://www.sqlalchemy.org/) and [Alembic](https://alembic.sqlalchemy.org/en/latest/)
- [Celery](https://docs.celeryq.dev/en/stable/)
- [Adminer](https://www.adminer.org//)
- [Redis](https://redis.io/)
- [Docker](https://www.docker.com/)
## :white_check_mark: Requirements
Before starting :checkered_flag:, you need to have [Python](https://www.python.org/) installed.
## :checkered_flag: Development
See [Development](./docs/development.md) docs.
## :checkered_flag: Installation
See [Server setup](./docs/server-setup.md) docs.
## :rocket: Deploy changes
See [Deployment](./docs/deployment.md) docs.
## :rocket: Access outside local intranet
As the API will almost certainly be hosted in a private network, behind a NAT router, we need a way to expose it to the outside world, in order for the cloud-hosted web app (or any external user) to access it. To do that, maybe the easiest option is to use a tunneling service like [Ngrok](https://ngrok.com).
```bash
$ ngrok http 8000 --scheme http,https
```
The command above will open a secure tunnel via one of the Ngrok servers and we'll be given a randomly generated URL (in Ngrok terminology, *ephemeral domain*), which we shall set as environment variable in our remote app server. Take into account that you will have to update your app server's environment each time you init the Ngrok tunnel.
An option to circumvent that problem, is to set up a *static domain* in your [Ngrok dashboard](https://dashboard.ngrok.com/cloud-edge/domains). You can read more about Ngrok domains in the [docs](https://ngrok.com/docs/network-edge/domains-and-tcp-addresses/#domains).
```bash
$ ngrok http --domain={{my-static-domain}} 8000 --scheme http,https
```
**NOTE:** We recommend using a static domain for production, and ephemeral domains to test the connection between the web app and the API in development environment/branches.
### Docker
We provide an optional service for `Ngrok` to run with `docker compose`. To run it, you must allow the services with [profile](https://docs.docker.com/compose/profiles/) *ngrok* when running `docker compose up`.
```bash
$ docker compose --profile=ngrok up -d
```
To know the ephemeral URL generated by Ngrok, you can access [Ngrok dashboard](http://localhost:4040/status) in your browser or, if you are using Linux, run the following command:
```bash
$ curl -s localhost:4040/api/tunnels | jq -r '.tunnels[0].public_url'
```
## :memo: License
This project is under license from MIT. For more details, see the [LICENSE](LICENSE.md) file.
## :writing_hand: Authors
Made with :heart: by Leandro Bertoluzzi and MartÃn Sellart.