Difference between revisions of "RoboCup Software"

From RoboJackets Wiki
Jump to navigation Jump to search
(Overview)
 
(7 intermediate revisions by 3 users not shown)
Line 1: Line 1:
=Overview=
+
= Overview =
 +
 
 
RoboCup Software encompasses all parts of the system that run on a host machine (not the robots). The entire software system is composed both of the components we play soccer and compete with as well as a sort of SDK that allows new components to be written quickly for idea and system testing.
 
RoboCup Software encompasses all parts of the system that run on a host machine (not the robots). The entire software system is composed both of the components we play soccer and compete with as well as a sort of SDK that allows new components to be written quickly for idea and system testing.
  
We currently host our software project on github, so check it out: https://github.com/RoboJackets/robocup-software.
+
We currently host our software project on github, so check it out: [https://github.com/RoboJackets/robocup-software https://github.com/RoboJackets/robocup-software].
 +
 
 +
= Main Programs =
  
=Tasks=
+
;[[RoboCup Soccer|soccer]] 
The RoboCup software team is using a program called Redmine for task management.  It serves as a centralized todo-list to keep track of what needs to be done and who's in charge of doing it.  For information about Redmine, check out their [http://www.redmine.org/projects/redmine/wiki/Tutorials Tutorials Page].
+
:Everything after [[RoboCup_Vision|vision]] and before radio happens here.
 +
;[[RoboCup Simulator|simulator]] 
 +
:Simulates a game environment, including vision and radio
 +
;[[RoboCup_Referee|sslrefbox]] 
 +
:The standard SSL referee box for issuing referee commands to all teams
 +
;radio 
 +
:Radio communication with on-field robots
  
The RoboCup Redmine site can be found at: https://redmine.robojackets.org.
+
= Logging Utilities =
  
[[C++ Homeworks]]
+
;log_viewer 
 +
:Playback of logged data
 +
;simple_logger 
 +
:Records vision and referee data just like soccer does, but with no processing.
 +
;convert_tcpdump 
 +
:Reads vision and referee packets from a tcpdump file and generates a log file. Use with util/log_vision.
  
=Main Programs=
+
= Development =
; [[RoboCup Soccer | soccer]] : Everything after vision and before radio happens here.
 
; [[RoboCup Simulator | simulator]] : Simulates a game environment, including vision and radio
 
; sslrefbox : The standard SSL referee box for issuing referee commands to all teams
 
; radio : Radio communication with on-field robots
 
  
=Logging Utilities=
+
;[[RoboCup Tips&Tricks]] 
; log_viewer : Playback of logged data
+
:Some pointers on how to begin writing and debugging code.
; simple_logger : Records vision and referee data just like soccer does, but with no processing.
+
;[[RoboCup GIT HOWTO]] 
; convert_tcpdump : Reads vision and referee packets from a tcpdump file and generates a log file.  Use with util/log_vision.
+
:We currently use Git as our code management system, and this will explain how to acquire and update the code base.
 +
;[[RoboCup Simulator Execution]] 
 +
:How to start and configure the simulator and connect to one or two soccer playing modules, as well as the Referee Module
 +
;[[RoboCup Live Robot Execution]] 
 +
:How to start and run the soccer with actual robots, connect to shared vision, and receive commands from the Referee Module
  
=Development=
+
= Conventions =
; [[RoboCup Setup]] : A step by step guide to setting up your new Linux system with our code base.
 
; [[RoboCup Boost Unit Tests]] : Explains how Boost Unit Testing Framework is integrated into and run from [[SCons]].
 
; [[RoboCup Coding Standard]] : Coding standard
 
; [[RoboCup Tips&Tricks]] : Some pointers on how to begin writing and debugging code.
 
; [[RoboCup GIT HOWTO]] : We currently use Git as our code management system, and this will explain how to acquire and update the code base.
 
; [[RoboCup Eclipse HOWTO]] : You can use any editor you want, but one useful one is Eclipse.  This HOWTO explains how to get an set up eclipse.
 
; [[RoboCup Compile HOWTO]] : System requirements, dependencies, and using the build tools to compile all of the software.
 
; [[RoboCup Simulator Execution]] : How to start and configure the simulator and connect to one or two soccer playing modules, as well as the Referee Module
 
; [[RoboCup Live Robot Execution]] : How to start and run the soccer with actual robots, connect to shared vision, and receive commands from the Referee Module
 
; [[RoboCup Vision System]] : How to setup the vision system (camera calibration, blob detection, etc.)
 
; [[Robocup Play Development HOWTO]] : How to create a simple play to get started
 
  
=Conventions=
+
There are a variety of conventions used throughout the code, both to represent soccer-playing, and to maintain consistency in code development.
There are a variety of conventions used throughout the code, both to represent soccer-playing, and to maintain consistency in code development.
 
; [[RoboCup Robot Identification]] : The means by which specific robots and field entities can be identified
 
; [[RoboCup Field Structure]] : The coordinate systems and their relationship to the field
 
; [[RC_FieldCamera| Field and Camera Information]] : Specifications on our cameras
 
  
[[Category: RoboCup]]
+
;[[RoboCup Field Structure]] 
[[Category: Software]]
+
:The coordinate systems and their relationship to the field
[[Category: Year: 2013-2014]]
+
;[[RC FieldCamera|Field and Camera Information]] 
 +
:Specifications on our cameras
 +
[[Category:RC Software]]<br/>[[Category:2013-2014]]

Latest revision as of 20:39, 24 May 2020

Overview

RoboCup Software encompasses all parts of the system that run on a host machine (not the robots). The entire software system is composed both of the components we play soccer and compete with as well as a sort of SDK that allows new components to be written quickly for idea and system testing.

We currently host our software project on github, so check it out: https://github.com/RoboJackets/robocup-software.

Main Programs

soccer 
Everything after vision and before radio happens here.
simulator 
Simulates a game environment, including vision and radio
sslrefbox 
The standard SSL referee box for issuing referee commands to all teams
radio 
Radio communication with on-field robots

Logging Utilities

log_viewer 
Playback of logged data
simple_logger 
Records vision and referee data just like soccer does, but with no processing.
convert_tcpdump 
Reads vision and referee packets from a tcpdump file and generates a log file. Use with util/log_vision.

Development

RoboCup Tips&Tricks 
Some pointers on how to begin writing and debugging code.
RoboCup GIT HOWTO 
We currently use Git as our code management system, and this will explain how to acquire and update the code base.
RoboCup Simulator Execution 
How to start and configure the simulator and connect to one or two soccer playing modules, as well as the Referee Module
RoboCup Live Robot Execution 
How to start and run the soccer with actual robots, connect to shared vision, and receive commands from the Referee Module

Conventions

There are a variety of conventions used throughout the code, both to represent soccer-playing, and to maintain consistency in code development.

RoboCup Field Structure 
The coordinate systems and their relationship to the field
Field and Camera Information 
Specifications on our cameras