Once your RemoteRF server and SDRs are running, preparing a specific course offering takes only a few minutes from the server console (serverrf -s). With a course user group and enrollment codes configured, the platform runs autonomously throughout the academic term with little to no instructor intervention.
About User Groups & Enrollment Codes
RemoteRF uses user groups and enrollment codes to scope access per class without manually creating or editing individual student accounts:
- User Groups: A user group defines the permissions and privileges of its members, including which SDR device IDs members can see and reserve, the maximum duration of each reservation, the maximum number of concurrent reservations a student may hold, and an optional expiration lifetime.
- Enrollment Codes: An enrollment code is a token that students enter when enrolling via
remoterf -rorremoterf --login. Registering or enrolling with an enrollment code automatically places the student’s account into the associated user group.
Multiple Courses on One Server: A single RemoteRF server can support multiple classes or research groups simultaneously. Simply create a separate user group for each course offering (e.g.,
ee123_f26andee230_f26) with its own device whitelist and reservation policy.
Step 1: Creating a User Group
First, inspect the connected radios in your running server@remoterf: shell so you know which device IDs to assign to your class:
devices listNext, create a new user group for your course offering:
groups createYou will be prompted for the following settings:
- Group name: Use a clear course and term identifier such as
ee123_f26(students see this group name when checking their permissions). - Devices whitelist: Comma-separated device IDs that members of this class may access (e.g.,
0,1,2,3,4,5,6,7). You can optionally leave one SDR off the student whitelist to reserve it for instructor/TA testing. - Max reservation time: Maximum duration of a single reservation in seconds (default
1800= 30 minutes). - Max concurrent reservations: Maximum concurrent reservations a student can hold at once (default
3). - Group lifetime: Group lifetime in seconds (
0means never expires, or set to the length of the academic term). - Max days ahead a reservation may start: Booking horizon in days (default
7days;0means no limit). - Reachable via Global / Public: Whether enrolled students can access the group from outside your network via RemoteRF Global (default
Y), and whether the group should be open to all Global users without an enrollment code (defaultNfor courses).
After creating the group, verify it and record its group_id for the next step:
groups listStep 2: Generating Enrollment Codes
Students need a valid enrollment code to enroll in your course group. To generate a batch of enrollment codes attached to your course’s group_id, run:
codes createYou will be prompted for:
- How many enrollment codes to generate
- Whether to attach a user group (
Y) and thegroup_idof the user group to attach them to - Characters per code name (default
10, minimum4;4or5characters is convenient for students) - Confirmation (
Use these codes?) after previewing the generated code names - Uses per code (default
1for single-use codes) - Duration in seconds of the code’s validity (
0= never expires)
Generate Extra Spare Codes: If you teach a class of 60 students, generate around 90 to 120 single-use codes (
uses = 1). Keeping extra single-use codes on hand makes it effortless to accommodate late-adding students or issue a replacement code on standalone local servers. Avoid using a single multi-use code for an entire class, as a single student could use it to register multiple accounts and bypass reservation quotas.
Step 3: Distributing Codes to Students
To export all generated enrollment codes to a CSV file in the server machine’s Downloads folder, run:
codes csvYou can also view active codes in the terminal with codes list or export group metadata with groups csv.
Quick Distribution Tip: Open the exported CSV file in Excel or Google Sheets and place each student’s university ID number next to an enrollment code. For added privacy when sharing a lookup sheet with your class, use =RIGHT(CELL, 4) to display only the last 4 or 5 digits of each student’s university ID alongside their assigned enrollment code, then export as a PDF. (Note that enrollment codes are not tied to a specific student until used to register.)
Mid-Course Modifications & Cleanup
Editing Group Permissions Mid-Term
If you add new SDRs to your deployment mid-quarter or want to adjust reservation limits before a final project deadline, run:
groups editEnter the group ID and update any combination of group name, device whitelist, maximum reservation time, maximum concurrent reservations, or group lifetime. Changes apply to all existing members of the user group.
Revoking Enrollment Codes
To revoke a single unused/leaked enrollment code by name, or all remaining codes for a group after add/drop ends:
codes removeRemoving enrollment codes only prevents new enrollments with those codes; students who have already enrolled remain in the group.
End-of-Term Cleanup
If your course user group was not already configured to expire automatically, you can manually remove it at the end of the term with groups remove (or disable access via groups edit) so students no longer hold reservation privileges on the hardware:
groups remove