standardbots 2.20250128.39__tar.gz → 2.20250417.1__tar.gz

{standardbots-2.20250128.39 → standardbots-2.20250417.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: standardbots
-Version: 2.20250128.39
+Version: 2.20250417.1
 Summary: Standard Bots RO1 Robotics API
 Home-page: 
 Author: Standard Bots Support

{standardbots-2.20250128.39 → standardbots-2.20250417.1}/README.md

@@ -20,15 +20,40 @@ To run a script move into the `sdks/python` folder and run `python playground/fi
 
 # Tests
 
+## `botctl` commands
+
+You may now use the `botctl` commands to setup and run tests.
+
+Set up the testing environment on the computer where you are running the tests:
+
+```bash
+# Setup testing environment
+botctl publicapi test:setup --help
+
+# Run tests
+botctl publicapi test --help
+```
+
+Set up the bot environment on the robot:
+
+```bash
+botctl publicapi test:setup-bot
+```
+
 ## Setup
 
 To set up tests:
 
 ```bash
 cd sdks/python
+```
 
-pip install -r requirements.txt
-pip install -r requirements-dev.txt
+Note: Make sure to select proper python interpreter.
+Sometimes there is an error related to missing "dotenv" module, to solve this install it separately
+
+```
+python3 -m pip install python-dotenv
+python3 -m pip install -r requirements-dev.txt
 ```
 
 ### Create sample data
@@ -71,7 +96,7 @@ python3 -m pytest ./tests --cov=standardbots
 
 ### Robot state and testing (Markers)
 
-We need the bot to be in a certain state to run certain tests. For example, we need a routine to be running in order to stop the routine.
+We need the bot to be in a certain state to run certain tests. For example, we need a routine to be running in order to stop the routine. Camera should be connected by default.
 
 At start of testing, robot should:
 
@@ -81,19 +106,23 @@ At start of testing, robot should:
 The basic idea here is:
 
 - These special tests will not be run by default.
-- You may pass a flag (e.g. `--routine-running`) when the bot is in the correct state to run the tests.
-- When the flag is passed:
+- You may pass a flag (e.g. `--camera-disconnected`) when the bot is in the correct state to run the tests.
+- Markers usage:
+- When `--gripper=<type>` flag is passed(`type` is value from `GripperKindEnum` enum):
+  1. Tests expect that this specific gripper is connected
+  2. Tests without the flag are not run.
+- When `--camera-disconnected` flag is passed:
   1. Tests with the flag are run.
   2. Tests without the flag are not run.
 
 We use [pytest markers](https://docs.pytest.org/en/7.1.x/example/markers.html) to do this.
 
-#### Routine running
+#### Camera disconnected
 
-The special sample routine ("Test Public API") should be running prior to running these tests. Then do:
+The wrist camera should be disabled. Then run:
 
 ```bash
-python3 -m pytest ./tests --cov=standardbots --routine-running
+python3 -m pytest ./tests --cov=standardbots --camera-disconnected
 ```
 
 #### E-stop
@@ -137,5 +166,35 @@ To test custom sensors:
 Then run:
 
 ```bash
-python3 -m pytest ./tests --cov=standardbots --custom-sensors
+python3 -m pytest ./tests --cov=standardbots --gripper=custom_sensors
+```
+
+## Database backups
+
+> See command: `botctl publicapi test:setup-bot`.
+
+We now have a common robot database state that can be used for testing. While this isn't necessary for use, it does provide a common state for testing.
+
+### How to create a new backup
+
+In the place where you are running the stack and want to create the backup (e.g. on the control box):
+
+```bash
+DB_USER=sb
+DB_NAME=sb
+BACKUP_FILE=$HOME/db-backup-publicapi-test.sql
+
+docker exec -it postgres-bot pg_dump -U $DB_USER -d $DB_NAME -F c -f /tmp/backup.sql
+
+docker cp postgres-bot:/tmp/backup.sql $BACKUP_FILE
+```
+
+If you need to download to the actual development environment:
+
+```bash
+CB_FILE=/home/control-box-bot/db-backup-publicapi-test.sql
+VM_FILE=~/sb/golang/apps/botctl/commands/publicapi/db-backup-publicapi-test.sql
+
+# Move directly to VM:
+scp cb2047:$CB_FILE $VM_FILE
 ```

{standardbots-2.20250128.39 → standardbots-2.20250417.1}/setup.py

@@ -13,7 +13,7 @@
 from setuptools import setup, find_packages  # noqa: H301
 
 NAME = "standardbots"
-VERSION = "2.20250128.39"
+VERSION = "2.20250417.1"
 # To install the library, run the following
 #
 # python setup.py install