Skip to content

Interfaces for managing Continuous Recording #12

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.

Sign up for GitHub

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
+95 −0
Open

Interfaces for managing Continuous Recording #12

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a47b669
Retention management services
Oct 31, 2025
73d3915
List continuous recordings service
Nov 5, 2025
f2542a0
Delete recording interface
Nov 6, 2025
4211716
datetime and retain recording interfaces
Nov 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ rosidl_generate_interfaces(${PROJECT_NAME}
"msg/HttpRequest.msg"
"msg/HttpResponse.msg"
"msg/MapIdNamePair.msg"
"msg/DateTime.msg"
"srv/FetchRouteNode.srv"
"srv/ModifyRouteNode.srv"
"srv/ModifyRouteEdge.srv"
Expand All @@ -63,6 +64,11 @@ rosidl_generate_interfaces(${PROJECT_NAME}
"srv/ListBagRecordings.srv"
"srv/DeleteMap.srv"
"srv/ListMaps.srv"
"srv/StartBagRetention.srv"
"srv/StopBagRetention.srv"
"srv/ListContinuousRecordings.srv"
"srv/DeleteContinuousRecording.srv"
"srv/RetainRecording.srv"
"action/GenerateOfflineMap.action"
DEPENDENCIES ${dependencies}
)
Expand Down
9 changes: 9 additions & 0 deletions msg/DateTime.msg
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Date
uint16 year
uint8 month
uint8 day

# Time (UTC)
uint8 hour
uint8 minute
uint8 second
24 changes: 24 additions & 0 deletions srv/DeleteContinuousRecording.srv
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
## Request

# Recording Types (enum)
#
# BUFFER_FILE: Delete a recording from the buffer dir
# KEEP_SESSION: Delete a session from keep dir
uint8 BUFFER_FILE=0
uint8 KEEP_SESSION=1


# Type of request (see options above)
uint8 delete_request_type

# File/session name
string name

---
## Response

# Indicate successful run of service
bool success

# Error messages
string error
15 changes: 15 additions & 0 deletions srv/ListContinuousRecordings.srv
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
## Request

---
## Response

# Indicate successful run of service
bool success

# Bag recordings from each category
BagRecording[] active_recordings
BagRecording[] buffer_recordings
BagRecording[] keep_sessions

# Error messages
string error
19 changes: 19 additions & 0 deletions srv/RetainRecording.srv
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
## Request

# Start time for retention
polymath_msgs/DateTime start_time

# End time for retention
polymath_msgs/DateTime end_time
Comment on lines +3 to +7
Copy link
Contributor

@troygibb troygibb Nov 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why define a new datetime? Why not rostime? Let other tools define the human readable interface

Copy link
Contributor Author

@dhruvtya dhruvtya Nov 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since all bags are stored with UTC timestamp, I assume it'll be more intuitive for someone to provide that when requesting to retain bags instead of builtin_interfaces/Time (sec + nanosec). Would be intuitive to use from raw service panels and cli as well if required

Copy link
Contributor

@troygibb troygibb Nov 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We will be writing tooling in Foxglove/Polyglot to set retentions right? They can manage the human readable datetime -> ros time conversion.


# Session suffix (optional, recommended)
string session_suffix

---
## Response

# Indicate successful run of service
bool success

# Error messages
string error
13 changes: 13 additions & 0 deletions srv/StartBagRetention.srv
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
## Request

# Session suffix (optional, recommended)
string session_suffix

---
## Response

# Indicate successful run of service
bool success

# Error messages
string error
9 changes: 9 additions & 0 deletions srv/StopBagRetention.srv
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
## Request
Copy link
Contributor

@troygibb troygibb Oct 31, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Given how generic this .srv is, why not just make it something like BasicRequest.srv?

Copy link
Contributor Author

@dhruvtya dhruvtya Oct 31, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah we can make a basic trigger request, since even StopBagRecording.srv is the same

---
## Response

# Indicate successful run of service
bool success

# Error messages
string error