PathGenerator is a motion profile path generator, which you can easily use to draw a path for your robot to follow.
When you finish setting up the path for your robot to follow, just press on the export button and use the CSV files on your robot to follow the path.
PathGenerator is based on PathGenerator package.
- Install Node.js
- Clone this repository
- Install all project dependencies:
npm i
- npm commands:
- Development:
npm run start-web
to run in web modenpm run start-app
to run in desktop mode
- Build:
npm run build-web
to build for web, Build files will located in/build
foldernpm run build-app
to build for desktop, Build files will located in/dist
folder
- Development:
Before you start planning your path you will need to setup your project in settings.
This is all you need to know for your project setup (settings):
- Folders Config - All the folders for your project
- Project folder - Where the project setting, paths and groups will be saved
- Path CSV folder - Where to export path CSV for your robot to use
- Path Config - All the information needed for calculating robot path
- Tank or Holonomic - Robot drive type
- Width and Length - Robot size in meters
- Max V and Acc - Robot max Velocity and acceleration in meters
- Loop time - Robot loop time in sec
- Filed Config
- Width and Height - Field size in meters
- Image - Field image to use, it can be image name in project folder or URL
- Top Left X and Y, Width and Height - Filed position in the field image
- Robot Draw Config - All the information needed for drawing your robot
- Width and Length - Robot full size with bumper in meters
- Center - Robot center in meters
After you finish setting up your project, all you need to do is create a path and start planning it.
This is all you need to know for planning your path:
- Create A New Path
- Click on
select path
button and thennew path
- Choose the name for your path
- Click on
- Add Waypoint
- Hold ctrl button and drag a waypoint
- Config Waypoint
- Drag a waypoint to move it on the filed
- Double click a waypoint to open waypoint info
- Click on a waypoint and then scroll for changing waypoint angle
- Click on a waypoint and then hold ctrl and scroll for changing waypoint robot angle (only for Holonomic)
- Play Path Preview
- Click on the
play
button to see how the robot will follow the path - Move the slider to the part in the path you want to see how your robot will be positioned
- Click on the filed and then scroll to see your robot following the path
- Click on the
- Export The Path
- Click on the
download
button to export the path as CSV file
- Click on the
After you finish creating the paths, you can create groups with those paths to see a preview off all the paths together.
This is all you need to know for planning your group:
- Create A Group
- Click on
select group
button and thennew group
- Choose the name for your group
- Click on
- Set Group Paths
- Click on
add path to group
button - Drag path name from paths to use to paths in group
- To change paths order in group drag the path name from paths in group to the position you want
- Click on
- Play The Group
- Click on the
play
button to see how the robot will follow the path - Move the slider to the part in the path you want to see how your robot will be positioned
- Click on the filed and then scroll to see your robot following the path
- Click on the
- Export Group Paths
- Click on the
download
button to export the path as CSV file
- Click on the
Action | Description |
---|---|
⌘ / alt + s | export path for robot to use |
⌘ / alt + f | change direction path |
⌘ / alt + n | create path / group |
⌘ / alt + r | rename path / group |
⌘ / alt + d | delete path / group |
⌘ / alt + p | open settings |
⌘ / alt + m | change mode |