wiki:Resources/Services/RFSwitch

Version 9 (modified by msherman, 6 years ago) ( diff )

Site Navigation

  1. COSMOS Testbed Overview
    1. Concepts
    1. Testbed Workflow
    1. Availability and Resource Status
    1. Events and Conferences
  2. Getting Started
    1. Make an Account
    2. Create and Configure SSH Keys
    3. Make a Reservation
    4. Log in to your Reservation
    5. Control Resources with OMF
    6. Run a Hello World Experiment
    7. Get Help and Support
  3. COSMOS/ORBIT User Guide
    1. The COSMOS Portal
    2. Connecting to the Testbed
    3. Running Experiments
    4. Policies and Support
    5. Quick Links
    1. Policies
    1. Account Creation
    1. Camera Streaming
    1. Scheduling and Reservations
    1. Disk Images
    1. Frequently Asked Questions
    1. Resource Control with OMF
  4. COSMOS Portal
    1. Your First Visit
    2. Setting Up Your Account
    3. Reserving Testbed Time
    4. Monitoring Your Experiment
    5. Connecting via SSH
    6. Managing Disk Images
    7. Joining the Community
    8. Browsing Users and Groups
    9. Tips
  5. Account Management
    1. Edit Profile
    2. Change Password
    3. SSH Keys
  6. Portal Dashboard
    1. Profile Card
    2. Usage Statistics
    3. Community Forum
  7. Directory
    1. Users
    2. Groups
    3. Privacy Note
  8. Disk Images
    1. Browsing Images
    2. Image Details
    3. Searching and Sorting
    4. Managing Your Images
    5. Baseline Images
    6. Saving Custom Images
    7. Storage and Retention
  9. Community Forum
    1. Accessing the Forum
    2. Forum Categories
    3. How to Use the Forum
    4. Forum Etiquette
    5. Privacy and Access
  10. Getting Started with the COSMOS Portal
    1. Creating an Account
    2. Logging In
    3. What to Do After Logging In
  11. SSH Access to Testbed Nodes
    1. Access Model
    2. Console Servers
    3. Basic Connection
    4. SSH Config File
    5. SSH Tunneling
    6. File Transfer
    7. Troubleshooting
  12. Scheduler
    1. Calendar View
    2. Reservation Colors
    3. Creating a Reservation
    4. Competing for a Slot
    5. Modifying or Canceling Reservations
    6. My Reservations
    7. Resource Information
  13. Testbed Status
    1. Node Status Grid
    2. RF Matrix Control (SB4)
    3. Understanding Node States During Experiments
    1. Remote Access
    1. Chrome Remote Desktop Setup Page
  14. Installing Chrome Remote Desktop (CRD) on a Custom Image
    1. Measurement & Result Collection
    1. Storage
    1. Support
    1. Contributing to the Wiki
  15. Tutorials
    1. SDR and Wireless
    2. Wireless Digital Twins
    3. Optical Networking
    4. Wired Networking
    5. Edge Computing
    6. 4G/5G Systems
    7. Orchestration Platforms
  16. Architecture
    1. Data Flow
    1. Deployment Map
    1. Domains
    1. Naming Convention
    1. Networks
    1. Optical
  17. Resources, Services and APIs
    1. RF Control
    2. SDR Control
    3. Compute Control
    4. Network Control
    5. Optical Control
  18. Datasets
  19. Hardware Info
    1. Cameras
    1. Compute
    1. FR3 SDRs
    1. Network
    1. Nodes
    1. Optical
    1. RF Subsystems
    1. Antennas
    1. Full-Duplex Radio
    1. RF Front End
    1. Software Defined Radios (SDR)
  20. RF Policies & Compliance
    1. Outdoor Radio Frequency Allocation
    2. Program Experiment License
    3. Spectrum Monitoring
    4. Emergency Stop Procedures
    5. Network and Platform Security

Service: RF Switch

This service is used to configure the RF switch boxes attached to certain nodes in sb1.cosmos-lab.org and sb2.cosmos-lab.org allowing the experimenter to select how nodes and antennas are connected.

RF Switch Boxes:

Name Location Connected Nodes/Devices
rfsw1.sb1.cosmos-lab.org COSMOS Sandbox 1 rfdev3-1, rfdev3-2, rfdev3-5
rfsw2.sb1.cosmos-lab.org COSMOS Sandbox 1 rfdev3-2, rfdev3-4, rfdev3-6
rfsw-s1-lg1.sb2.cosmos-lab.org COSMOS Sandbox 2 sdr1-s1-lg1, sdr2-s1-lg1
rfsw-md1.sb2.cosmos-lab.org COSMOS Sandbox 2 sdr1-md1, sdr2-md1

Please visit the individual sandbox specific pages in the wiki for detailed block diagrams of the possible RF connections that can be made.


Usage

All the available methods are accessible from the a testbed console via an HTTP API located at am1.cosmos-lab.org:5054/rf_switch. This API can be interacted with via a command line tool such as "curl" or any script using a "REST client" library.


Get the current configuration

This API call is used to get the current configuration of the RF switch box(es). The response will specify the switch/port configurations of the RF switch box(es) in question.

HTTP API Path: am1.cosmos-lab.org:5054/rf_swtich/status

Parameters:

Name Decription Required Acceptable Input
name Comma separated list of RF switch box FQDNs Y (list of RF switch boxes)


Example 1

HTTP Request:

am1.cosmos-lab.org:5054/rf_switch/status?name=rfsw1.sb1.cosmos-lab.org

Response:

<response status="OK">
  <rf_switch name="rfsw1.sb1.cosmos-lab.org" num_of_switches="4">
    <switch number="1" port="1"/>
    <switch number="2" port="1"/>
    <switch number="3" port="1"/>
    <switch number="4" port="1"/>
  </rf_switch>
</response>


Example 2

HTTP Request:

am1.cosmos-lab.org:5054/rf_switch/status?name=rfsw1.sb1.cosmos-lab.org,rfsw2.sb1.cosmos-lab.org

Response:

<response status="OK">
  <rf_switch name="rfsw1.sb1.cosmos-lab.org" num_of_switches="4">
    <switch number="1" port="1"/>
    <switch number="2" port="1"/>
    <switch number="3" port="1"/>
    <switch number="4" port="1"/>
  </rf_switch>
  <rf_switch name="rfsw2.sb1.cosmos-lab.org" num_of_switches="4">
    <switch number="1" port="1"/>
    <switch number="2" port="1"/>
    <switch number="3" port="1"/>
    <switch number="4" port="1"/>
  </rf_switch>
</response>


Configure the RF switch

HTTP API Path: am1.cosmos-lab.org:5054/rf_switch/set

Parameters:

Name Decription Required Acceptable Input
name Comma separated list of RF switch box FQDNs Y (list of RF switch boxes)
switch Comma separated list of switch(es) to configure Y (list of switch numbers)
port Port to select on RF switch Y 1, 2


Example 1

For rfsw1.sb1.cosmos-lab.org and rfsw2.sb1.cosmos-lab.org, configure switches 2 and 3 to the second port.

HTTP Request:

am1.cosmos-lab.org:5054/rf_switch/set?name=rfsw1.sb1.cosmos-lab.org,rfsw2.sb1.cosmos-lab.org&switch=2,3&port=2

Response:

<response status="OK">
  <message>OK</message>
</response>
Note: See TracWiki for help on using the wiki.