Merge pull request #12 from ThundeRatz/develop

Update master to release v2.0

Author: d-nery

.all-contributorsrc

@@ -0,0 +1,98 @@
+{
+  "projectName": "vss_simulation",
+  "projectOwner": "thunderatz",
+  "repoType": "github",
+  "repoHost": "https://github.com",
+  "files": [
+    "README.md"
+  ],
+  "imageSize": 100,
+  "commit": true,
+  "commitConvention": "gitmoji",
+  "contributors": [
+    {
+      "login": "FelipeGdM",
+      "name": "Felipe Gomes de Melo",
+      "avatar_url": "https://avatars3.githubusercontent.com/u/1054087?v=4",
+      "profile": "https://github.com/FelipeGdM",
+      "contributions": [
+        "doc",
+        "review",
+        "code",
+        "translation"
+      ]
+    },
+    {
+      "login": "LucasHaug",
+      "name": "Lucas Haug",
+      "avatar_url": "https://avatars3.githubusercontent.com/u/39196309?v=4",
+      "profile": "https://github.com/LucasHaug",
+      "contributions": [
+        "review"
+      ]
+    },
+    {
+      "login": "Tocoquinho",
+      "name": "tocoquinho",
+      "avatar_url": "https://avatars2.githubusercontent.com/u/37677881?v=4",
+      "profile": "https://github.com/Tocoquinho",
+      "contributions": [
+        "ideas",
+        "doc"
+      ]
+    },
+    {
+      "login": "Berbardo",
+      "name": "Bernardo Coutinho",
+      "avatar_url": "https://avatars0.githubusercontent.com/u/48636340?v=4",
+      "profile": "https://github.com/Berbardo",
+      "contributions": [
+        "review",
+        "code",
+        "doc"
+      ]
+    },
+    {
+      "login": "lucastrschneider",
+      "name": "Lucas Schneider",
+      "avatar_url": "https://avatars0.githubusercontent.com/u/50970346?v=4",
+      "profile": "https://github.com/lucastrschneider",
+      "contributions": [
+        "review",
+        "code",
+        "translation",
+        "doc"
+      ]
+    },
+    {
+      "login": "JuliaMdA",
+      "name": "Júlia Mello",
+      "avatar_url": "https://avatars1.githubusercontent.com/u/65100162?v=4",
+      "profile": "https://github.com/JuliaMdA",
+      "contributions": [
+        "design",
+        "data"
+      ]
+    },
+    {
+      "login": "ThallesCarneiro",
+      "name": "ThallesCarneiro",
+      "avatar_url": "https://avatars1.githubusercontent.com/u/71659373?v=4",
+      "profile": "https://github.com/ThallesCarneiro",
+      "contributions": [
+        "design",
+        "data"
+      ]
+    },
+    {
+      "login": "TetsuoTakahashi",
+      "name": "TetsuoTakahashi",
+      "avatar_url": "https://avatars2.githubusercontent.com/u/38441802?v=4",
+      "profile": "https://github.com/TetsuoTakahashi",
+      "contributions": [
+        "ideas"
+      ]
+    }
+  ],
+  "contributorsPerLine": 7
+}

.gitignore

@@ -1,4 +1,4 @@
-# .gitignore taken from https://github.com/ThundeRatz/ThunderTrekking
+# .gitignore taken from https://github.com/ThundeRatz/ThunderTrekking-Public
 
 *.o
 *~
@@ -38,3 +38,9 @@ missing
 
 # Doxygen generated files
 Doxygen/
+
+# Python virtual enviroment
+venv/*
+
+# ROS bagfiles
+*.bag

.vscode/settings.json

@@ -1,12 +1,12 @@
 {
-    "ros.distro": "melodic",
+    "ros.distro": "noetic",
     "doxdocgen.generic.dateFormat": "MM/YYYY",
     "doxdocgen.file.copyrightTag": [
-        "@copyright MIT License - Copyright (c) {year} ThundeRatz"
+        "@copyright MIT License - Copyright (c) 2020 ThundeRatz"
     ],
     "C_Cpp.default.configurationProvider": "go2sh.cmake-integration",
     "python.autoComplete.extraPaths": [
-        "/opt/ros/melodic/lib/python2.7/dist-packages"
+        "/opt/ros/noetic/lib/python3/dist-packages"
     ],
     "files.associations": {
         "*.world": "xml",
@@ -16,5 +16,4 @@
     },
     "python.linting.pycodestyleEnabled": true,
     "python.linting.enabled": true,
-    "python.linting.pep8Enabled": true,
 }

CHANGELOG.md

@@ -1,34 +1,67 @@
 # Changelog
 
-## v2.0.0-alpha
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-- Quebra de compatibilidade com a v1.0.0
-- Tópicos recebem o valor do **torque em Nm**
+Para a versão em PT-BR 🇧🇷 desse documento, veja [aqui](./CHANGELOG.pt-br.md)
+
+## [2.0.0] - 2020-10-05 - [Open Camera](https://github.com/ThundeRatz/vss_simulation/releases/tag/v2.0)
+
+### Added
+
+- Software license (MIT)
+- Generic vss robot model
+- Gazebo camera plugin
+- File requirements.txt for python virtual environments
+
+### Changed
+
+- Upgrade to Gazebo 11 and ROS noetic
+- Simulation environmet released as free software
+
+### Deprecated
+
+- Remove original model of ThunderVolt team
+
+### Known problems
+
+- Ball physical properties
+- The simulation fails to start sometimes
+
+## [2.0.0-alpha] - 2020-05-12
+
+### Added
+
+- Simulation of dry and viscous friction in wheels movement
+- Dependency ```effort_controllers```
+
+### Changed
+
+- Topics receive the command of **torque in Nm**
   - /robotX/vss_robot_left_controller/command
   - /robotX/vss_robot_right_controller/command
-- Padronização da nomenclatura com o VSSVision
-- Simulação do atrito seco e viscoso no movimento das rodas
-- Adição do ```effort_controllers``` como dependência
+- Name standardization with VSSVision
+
+### Known problems
 
-### Problemas conhecidos
+- Ball physical properties
+- The simulation fails to start sometimes
 
-- Propriedades físicas da bola
-- A simulação falha em iniciar ocasionalmente
+## [1.0.0] - 2020-05-04 - [Iron Cup 2020](https://github.com/ThundeRatz/vss_simulation/releases/tag/v1.0)
 
-## v1.0.0 - Iron Cup 2020
+### Added
 
-- Primeira versão funcional
-- Projeto mecânico v1.1 - Thalles e Diego
-- Controle dos motores pela **velocidade em rad/s**
+- Mechanical project v1.1 - Thalles e Diego
+- Motors control with **velocity in rad/s**
   - /robot_X/vss_robot_left_controller/command
   - /robot_X/vss_robot_right_controller/command
-- Ambientes de simulação
-  - Robô único
-  - Time de 3
-  - Partida 3x3
-- Adição do ```velocity_controllers``` como dependência
+- Simulation environments
+  - Single robot
+  - Team of 3
+  - Match 3x3
+- Dependency ```velocity_controllers```
 
-### Problemas conhecidos
+### Known problems
 
-- Propriedades físicas da bola
-- Comportamento dos motores ideal demais - longe da realidade
+- Ball physical properties
+- Motors behavior too ideal - far from reality

CHANGELOG.pt-br.md

@@ -0,0 +1,66 @@
+# Changelog
+
+O formato é baseado no [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+e esse projeto segue a convenção [versionamento semântico](https://semver.org/spec/v2.0.0.html).
+
+## [2.0.0] - 2020-10-05 - [Open Camera](https://github.com/ThundeRatz/vss_simulation/releases/tag/v2.0)
+
+### Adicionado
+
+- Licensa de software (MIT)
+- Modelo de robô vss genérico
+- Plugin de câmero do Gazebo
+- Arquivo requirements.txt para ambientes virtuais de python
+
+### Modificado
+
+- Atualização para Gazebo 11 e ROS noetic
+- Ambiente de simulação liberado como software livre
+
+### Obsoleto
+
+- Remoção do modelo original do time ThunderVolt
+
+### Problemas conhecidos
+
+- Propriedades físicas da bola
+- A simulação falha em iniciar ocasionalmente
+
+## [2.0.0-alpha] - 2020-05-12
+
+### Adicionado
+
+- Simulação de atrito seco e viscoso no movimento das rodas
+- Dependência ```effort_controllers```
+
+### Modificado
+
+- Tópicos recebem o valor do **torque em Nm**
+  - /robotX/vss_robot_left_controller/command
+  - /robotX/vss_robot_right_controller/command
+- Padronização da nomenclatura com o VSSVision
+- Simulação do atrito seco e viscoso no movimento das rodas
+
+### Problemas conhecidos
+
+- Propriedades físicas da bola
+- A simulação falha em iniciar ocasionalmente
+
+## [1.0.0] - 2020-05-04 - [Iron Cup 2020](https://github.com/ThundeRatz/vss_simulation/releases/tag/v1.0)
+
+### Adicionado
+
+- Projeto mecânico v1.1 - Thalles e Diego
+- Controle dos motores pela **velocidade em rad/s**
+  - /robot_X/vss_robot_left_controller/command
+  - /robot_X/vss_robot_right_controller/command
+- Ambientes de simulação
+  - Robô único
+  - Time de 3
+  - Partida 3x3
+- Dependência```velocity_controllers```
+
+### Problemas conhecidos
+
+- Propriedades físicas da bola
+- Comportamento dos motores ideal demais - longe da realidade

CODE_OF_CONDUCT.md

@@ -0,0 +1,78 @@
+# Contributor Covenant Code of Conduct
+
+Para a versão em PT-BR 🇧🇷 desse documento, [veja aqui](CODE_OF_CONDUCT.pt-br.md).
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+ advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+ address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at comp@thunderatz.org. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq