Hi everyone,
Coding guidelines in my Background as an SW Engineer
I come from a software development background, where coding guidelines are a normal part of everyday work.
In software projects, these guidelines often come from several different sources. Some are general industry conventions, some are company or department requirements, and others are simply agreements made within a team. There are also many tools available that help developers follow these standards and keep code consistent.
This got me wondering:
- How do people approach this when programming or teaching robot applications?
- Do you have coding guidelines for robot programs?
- Do we even call them coding guidelines in this context?
On one hand, a PolyScope program is clearly a form of code. On the other hand, it is also very much a “click-clack-boom” graphical environment, so it feels different from traditional software development.
I’m particularly interested in how teams ensure consistency when multiple people are responsible for creating and maintaining robot programs.
Context: Our application
To provide some context, we are about to start a larger automation project where the robot’s primary task will be transporting DUTs (Devices Under Test). The robot will move parts between incoming stations, buffer locations, various test tools, back to those buffer locations when required, and eventually to outgoing stations.
From a programming perspective, this will result in roughly 100 individual “move” operations, most likely implemented as separate URPX programs. They are individually called and played by a Dispatcher Software, on a Desktop Computer.
One of our goals is to spread the knowledge across the team instead of having a single robot expert. At the moment, we have:
- Three people with PolyScope X Core Training (including myself)
- One person with PolyScope 5 Core Training
- Plans to train two additional people on PolyScope X
I would actually like all of them to contribute to the teaching and programming work. The current idea is to have people work in pairs and let each pair create a subset of the programs.
However, if six different people teach and structure programs in six different ways, maintenance will quickly become difficult. I would like all programs to follow a similar level of quality and look as if they came from a single team with a common methodology.
Also I’m already thinking about implementing some own kind of “StyleCop” running on a Desktop Computer which repeatedly downloads the Programs from the Robot.
So I’m curious:
- Do you define programming or teaching standards for your robot applications?
- If yes, what do those standards cover?
- Naming conventions?
- Program structure?
- Folder organization?
- Coordinate systems and feature usage?
- Error handling?
- Reusable components?
- Documentation?
- Code reviews or peer reviews?
- Any tools that help enforce consistency?
I would also be very interested in hearing any general recommendations, lessons learned, or best practices that you have found valuable when multiple people are working on the same robot cell over a longer period of time.
Thanks in advance for sharing your experiences!