Skip to main content

Robot control system for Stringman

Project description

nf_robot

Control code for the Stringman household robotic crane from Neufangled Robotics

Build Guides and Documentation

Purchase assembled robots or kits at neufangled.com

Installation of stringman controller

Linux (python 3.11 or later)

sudo apt install python3-dev python3-virtualenv python3-pip ffmpeg
python -m virtualenv venv
pip install "nf_robot[host]"

Start headless robot controller in a mode that connects to remote telemetry. The particular robot details will be read from/saved to bedroom.conf

stringman-headless --config=bedroom.conf

For LAN mode, see local_ui/README.md

Installation of Robot Control Panel (developers)

git clone https://github.com/nhnifong/cranebot3-firmware.git

sudo apt install python3-dev python3-virtualenv python3-pip ffmpeg
python -m virtualenv venv
source venv/bin/activate
pip install -e ".[host,dev,pi]"

If you have an RTX 5090

pip install --force-reinstall torch==2.8.0 torchvision==0.23.0 torchaudio==2.8.0 torchcodec==0.6.0 --index-url https://download.pytorch.org/whl/cu129

Run tests

pytest tests

Setting up a component

Robot components that boot from the stringman-zero2w.img (1.6GB) image should begin looking for wifi share codes with their camera immediately. You can produce a code with qifi.org

Once the pi sees the code it will connect to the network and remember those settings. It should then be discoverable by the control panel via multicast DNS (Bonjour)

Starting from a base rpi image

Alternatively the software can be set up from a fresh raspberry pi lite 64 bit image. After booting any raspberry pi from a fresh image, perform an update

sudo apt update -y && sudo apt full-upgrade -y -o Dpkg::Options::="--force-confold" && sudo apt install -y git python3-dev python3-virtualenv rpicam-apps i2c-tools

Clone the cranebot-firmware repo

git clone https://github.com/nhnifong/cranebot3-firmware.git && cd cranebot3-firmware

Set the component type by uncommenting the appropriate line in server.conf

nano server.conf

Install stringman

chmod +x install.sh
sudo ./install.sh

Additional settings for anchors

Setup for any raspberry pi that will be part of an anchor Enable uart serial harware interface interactively.

sudo raspi-config

In interface optoins, select serial port. disable the login shell, but enable hardware serial.

add the following lines lines to to /boot/firmware/config.txt at the end this disables bluetooth, which would otherwise occupy the uart hardware. Then reboot after this change

enable_uart=1
dtoverlay=disable-bt

Additional settings for gripper

Setup for the raspberry pi in the gripper with the inventor hat mini Enable i2c

sudo raspi-config nonint do_i2c 0

Add this line to /boot/firmware/config.txt just under dtparam=i2c_arm=on and reboot

dtparam=i2c_baudrate=400000

Rebuilding the python module

within a venv install the build tools

python3 -m pip install --upgrade build twine

Bump the version number in pyproject.toml then at this repo's root, build the module. Artifacts will be in dist/

python3 -m build

Upload to Pypi

python3 -m twine upload dist/*

QA scripts

Note that if you are proceeding to QA scripts right after doing the steps above you must reboot and then stop the service before running those scrips.

sudo reboot now

log back in

sudo systemctl stop cranebot.service

Run QA scripts for the specific component type

/opt/robot/env/bin/qa-anchor anchor|power_anchor
/opt/robot/env/bin/qa-gripper
/opt/robot/env/bin/qa-gripper-arp

These scripts both check whether everything is connected as it should be and in the case of anchors, set whether it is a power anchor or not.

Training models

Support this project

Donate on Ko-fi

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nf_robot-1.2.2.tar.gz (131.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

nf_robot-1.2.2-py3-none-any.whl (152.0 kB view details)

Uploaded Python 3

File details

Details for the file nf_robot-1.2.2.tar.gz.

File metadata

  • Download URL: nf_robot-1.2.2.tar.gz
  • Upload date:
  • Size: 131.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for nf_robot-1.2.2.tar.gz
Algorithm Hash digest
SHA256 86b236b2eae1fba5226475f0193fd6d6bd86c765f26f0284feb89bbb8e72f6e0
MD5 77c7159109698fc23fcc9bbb68266ece
BLAKE2b-256 c45294426b3dff0d6b23f36849386ced66e7901fd95f64c3f350736f5f0be82c

See more details on using hashes here.

File details

Details for the file nf_robot-1.2.2-py3-none-any.whl.

File metadata

  • Download URL: nf_robot-1.2.2-py3-none-any.whl
  • Upload date:
  • Size: 152.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for nf_robot-1.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 7e723c08005e4962b54a04f1214462322219265af21d05117335bf7e33c3196b
MD5 21df6d938fa924d6f1535c9a8591ebcf
BLAKE2b-256 b61c08815f0d4b1b2110d4d2f5b3977858b0b2a190eea1f5ce14df921f77ce30

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page