Feldfreund rendering # Feldfreund Dev Kit This is the source code of the [Feldfreund Dev Kit](https://zauberzeug.com/products/field-friend-dev-kit) for autonomous outdoor robotics made by [Zauberzeug](https://zauberzeug.com/). The software is based on [RoSys](https://rosys.io) and [NiceGUI](https://nicegui.io/). The micro controller is programmed with [Lizard](https://github.com/zauberzeug/lizard). Our agricultural weeding robot [Feldfreund](https://zauberzeug.com/feldfreund) is based on this platform and is intended to advance organic and regenerative agriculture. There is also a [ROS2 implementation](https://github.com/zauberzeug/feldfreund_devkit_ros) based on this repository. Please see the [documentation](https://docs.feldfreund.de) for details on installation, setup and usage. ## This repository is a mirror Development happens in Zauberzeug's internal monorepo. This repository is a read-only export of the package folder, so its history is a series of sync commits rather than the individual changes. Issues and pull requests are welcome and are read here. A pull request is reviewed on this repository and then applied as a patch in the monorepo, so the change arrives with the next export and the pull request is closed rather than merged. ## Development 1. create a virtual environment and activate it (you can skip this if you use uv, it creates and manages the venv for you): ```bash uv venv -p 3.12 source .venv/bin/activate # to activate your virtual environment ``` 2. install dependencies: ```bash uv sync ``` 3. start your project: ```bash uv run ./main.py ``` This starts the hardware whenever a serial port is reachable — on a Jetson that is always the case. Set `SIMULATION=true` in the environment to force the simulation. 4. run your tests: ```bash uv run pytest ``` ### Updating template settings To update your project configuration from the nicegui-template, run: ```bash copier update --skip-answered ``` This will prompt you to review and update your template settings interactively. If you changed a lot of the template files and have the feeling that not everything you expected to update was updated, you can also run: ```bash copier recopy ./path_to_your_project ``` Be careful with this command, as it will overwrite any local changes you made to the template files. It's recommended to then thoroughly review the changes generated by copier with git. ## pre-commit [pre-commit](https://pre-commit.com/) is a tool to help you manage and run pre-commit hooks in your code. It is used to check your code for e.g. extra whitespace or formatting errors before committing it. Install the pre-commit hooks by running: ```bash pre-commit install ``` You can also run the hooks manually by running: ```bash make pre-commit # which runs: # pre-commit run --all-files ```