In general, this release will attempt to address issues regarding outdated dependencies, ease of extensibility, new features with Open-RMF and UX. Admittedly not all features are well documented at the moment, and some newer UI features would benefit from tooltips on the frontend dashboard rather than written documentation. We will attempt to address these concerns in minor releases if they are absent in the first release.
Current state of branches
main - supports ROS 2 Jazzy, with mostly up-to-date dependencies, but missing newest features that were developed for live deployments
deploy/hammer-humble - live deployment branch, supports ROS 2 Humble, with the newest set of features and bug fixes, but with outdated dependencies. Features implemented for deployments were kept to this branch instead of main due to their customized nature where introducing it upstream will incur difficulties in maintenance as well as documentation.
koonpeng/hammer-jazzy-base - base branch where all the dependency updates, feature refactoring and porting, documentation and testing improvements, as well as cleanups and deprecations will happen.
The progress checklist below will target koonpeng/hammer-jazzy-base, and when ready, it will be labeled as the new main branch, while the original main branch will be set up as legacy/main for legacy uses. This move will incur changes in git history and therefore any users on the legacy main branch will no longer be able to pull, and will require a fresh clone of the repository.
As rmf-web is a monorepo all the packages will be tagged as the same version to best ensure compatibility from source or docker image releases.
Notable changes
Tasks
Various bug fixes and improved testing for task scheduling system.
Usage of task booking labels, which allow information encoded from a task creation form to propagate to task state updates. This is useful for displaying custom information onto the task queue table, e.g. pickup, destination/dropoff, task warning time, etc.
Delivery alert system (deprecated), use generic alerts instead.
Generic alerts system, replacing previously implemented robot or task specific alerts, https://github.com/open-rmf/rmf-web/pull/948. Other systems in the ecosystem is then able to trigger alerts on the frontend dashboard, requesting for user responses, for example a fleet adapter alerting users that the robot is obstructed, or requesting for a user response when the robot detects a wrong cart.
Robot Interaction Object (RIO), https://github.com/open-rmf/rmf-web/pull/960, which allows the API server and database to accommodate other entities within the ecosystem, e.g. Smart Carts, workcells, etc, by saving their states and allow for queries via REST, making it easier for user to implement their own frontend components for other entities.
aaronchongth
commented
1 month ago
Outline
This ticket details and tracks the progress towards the first tagged release of rmf-web, which will support
In general, this release will attempt to address issues regarding outdated dependencies, ease of extensibility, new features with Open-RMF and UX. Admittedly not all features are well documented at the moment, and some newer UI features would benefit from tooltips on the frontend dashboard rather than written documentation. We will attempt to address these concerns in minor releases if they are absent in the first release.
Current state of branches
main- supports ROS 2 Jazzy, with mostly up-to-date dependencies, but missing newest features that were developed for live deploymentsdeploy/hammer-humble- live deployment branch, supports ROS 2 Humble, with the newest set of features and bug fixes, but with outdated dependencies. Features implemented for deployments were kept to this branch instead ofmaindue to their customized nature where introducing it upstream will incur difficulties in maintenance as well as documentation.koonpeng/hammer-jazzy-base- base branch where all the dependency updates, feature refactoring and porting, documentation and testing improvements, as well as cleanups and deprecations will happen.The progress checklist below will target
koonpeng/hammer-jazzy-base, and when ready, it will be labeled as the newmainbranch, while the originalmainbranch will be set up aslegacy/mainfor legacy uses. This move will incur changes in git history and therefore any users on the legacymainbranch will no longer be able to pull, and will require a fresh clone of the repository.As
rmf-webis a monorepo all the packages will be tagged as the same version to best ensure compatibility from source or docker image releases.Notable changes
leafletsince migration toreact-three-fiber, https://github.com/open-rmf/rmf-web/pull/968.Progress checklist
Tickets resolved along the way
After release