Skip to content

DOCS-4112: Document machine job scheduling functionality with JobConfig #4426

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

promptless[bot]
Copy link
Contributor

@promptless promptless bot commented Jun 30, 2025

Based on PR RSDK-10963, document the new machine job scheduling functionality that allows users to configure automated jobs that run on machines at specified intervals. This PR adds the JobConfig definition to the robot.proto file, enabling users to schedule recurring tasks on their machines.

New Job Scheduling Features:

  • Configure jobs with unique names and scheduling intervals
  • Support for both unix-cron expressions and Golang duration strings for flexible scheduling
  • Target specific resources and methods for automated execution
  • Optional command parameters for DoCommand-based jobs
  • Integration with machine configuration through repeated JobConfig fields

Key Configuration Options:

  • name: Unique identifier for each scheduled job
  • schedule: Unix-cron string (e.g., "0 */6 * * *") or Golang duration (e.g., "5m", "1h") for job intervals
  • resource: Target resource name for the job execution
  • method: Specific gRPC method to call on the resource
  • command: Optional command arguments for DoCommand-based operations

Use Cases:

  • Automated data collection at regular intervals
  • Periodic maintenance tasks and system checks
  • Scheduled sensor readings and data logging
  • Regular component status monitoring
  • Automated calibration and configuration updates

The documentation should cover configuration examples, scheduling syntax, troubleshooting, and best practices for implementing reliable scheduled jobs on Viam machines. This represents a significant new capability for automating machine operations and reducing manual intervention requirements.

Trigger Events


If you want Promptless to make further changes on this PR, feel free to leave a comment tagging Promptless (It won't show up in the user drop down but Promptless will get it!)

Copy link

netlify bot commented Jun 30, 2025

Deploy Preview for viam-docs ready!

Name Link
🔨 Latest commit e5933e2
🔍 Latest deploy log https://app.netlify.com/projects/viam-docs/deploys/686278a4c04a370008e7af20
😎 Deploy Preview https://deploy-preview-4426--viam-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 47 (🔴 down 2 from production)
Accessibility: 100 (no change from production)
Best Practices: 100 (no change from production)
SEO: 92 (no change from production)
PWA: 70 (no change from production)
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify project configuration.

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@viambot
Copy link
Member

viambot commented Jun 30, 2025

👋 Thanks for contributing! A reviewer will look at it on the next working day!

Copy link
Contributor Author

promptless bot commented Jun 30, 2025

Just a reminder: If you'd like me to act on any feedback you have via Github comments, just type @Promptless in your suggestion and I'll get right on it! (I won't show up in the user dropdown, but I'll process any request that has @Promptless in the comment body.)

@npentrel npentrel changed the title DOCS-4112: Document new machine job scheduling functionality with JobConfig DOCS-4112: Document machine job scheduling functionality with JobConfig Jun 30, 2025
@npentrel npentrel marked this pull request as draft July 1, 2025 14:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants