Skip to content

Conversation

@sdiao
Copy link
Contributor

@sdiao sdiao commented Jun 1, 2021

Proposed change(s)

Describe the changes made in this PR.

Useful links (GitHub issues, JIRA tickets, forum threads, etc.)

Provide any relevant links here.

Types of change(s)

  • Bug fix
  • New feature
  • Code refactor
  • Documentation update
  • Other (please describe)

Testing and Verification

Please describe the tests that you ran to verify your changes. Please also provide instructions, ROS packages, and Unity project files as appropriate so we can reproduce the test environment.

Test Configuration:

  • Unity Version: [e.g. Unity 2020.2.0f1]
  • Unity machine OS + version: [e.g. Windows 10]
  • ROS machine OS + version: [e.g. Ubuntu 18.04, ROS Noetic]
  • ROS–Unity communication: [e.g. Docker]

Checklist

  • Ensured this PR is up-to-date with the dev branch
  • Created this PR to target the dev branch
  • Followed the style guidelines as described in the Contribution Guidelines
  • Added tests that prove my fix is effective or that my feature works
  • Updated the documentation as appropriate

Other comments

mpinol and others added 30 commits January 25, 2021 11:54
* Add ROS# link
…atically (#47)

* Fixing message name that should not take a capital first letter automatically
* Adding warning when a message file name starts with a lowercase character
* Moving package files into package subdirectory

* Adding tests and fixing Yamato config.

* Adding missing using statement to MessageParser
* Read message in chunks min

* Removing unpredictable DataAvailable check

* Configurable byte chun
k size

* Prevent infinite hang on reading message contents

* Wait for frame on data read retry

* PR Feedback
Partially addressing issue #71 wherein a user couldn't find up-to-date instructions for installing the connector into a new project.
* Contributing content commit

* Link fix

* PR feedback
* Read multiple messages from each connection

* Compiles

* First thing sent on each new connection is the timeout

* Comments!

* Stop the connection on leaving play mode

* Add a "timeout on idle" config setting so Endpoint doesn't have to send it
Resolve the conflicts to merge dev to main
add changelog
The path from the package root to the root of the PregeneratedMessages
folder was 47 characters. From within the PickAndPlace project, the
fully qualified path including drive letter, path to workspace, and path
to its location in the package cache can easily exceed 200 characters,
especially for users with long names or deep workspace organization.
The maximum allowed path length for a fully qualified path in Windows is
260 characters, after which an IDE can not compile the assemblies for
source with too-long paths.

Moved Runtime/MessageGeneration/PregeneratedMessages to
Runtime/Messages, which saves 30 characters off the full path name. This
is a mitigation that can not fully solve the problem, but wil at least
reduce the number of cases for which the ROS-TCP-Endpoint assemblies
fail to compile due to path length.

Tested on my machine by manually renaming the directory in my
PackageCache.
* Add editorconfig for formatting

* Use linter to format the package code

* Add pre-commit hook

* Fix line endings for markdown

Fix trailing-whitespace

* Remove ruby setup; Change to run pre-commit only on pull-requests
* Merge 0.3.0 to main (#90)

* Add ROS# link (#55)

* Add ROS# link

* Fixing message name that should not take a capital first letter automatically (#47)

* Fixing message name that should not take a capital first letter automatically
* Adding warning when a message file name starts with a lowercase character

* AIRO-331 Code Cleanup and Testing Framework (#57)

* Moving package files into package subdirectory

* Adding tests and fixing Yamato config.

* Adding missing using statement to MessageParser

* RosMessageGeneration namespace change (#61)

* Amanda/read chunks (#62)

* Read message in chunks min

* Removing unpredictable DataAvailable check

* Configurable byte chun
k size

* Prevent infinite hang on reading message contents

* Wait for frame on data read retry

* PR Feedback

* Adding prebuilt ObjectRecognition and Octomap messages (#64)

* M prefix for all messages (#66)

* Topic list service (#72)

* Adding install instructions to README

Partially addressing issue #71 wherein a user couldn't find up-to-date instructions for installing the connector into a new project.

* Updating Contribution Content (#77)

* Contributing content commit

* Link fix

* PR feedback

* Adding PR template (#81)

* One persistent connection for all messages sent to Unity

* Read multiple messages from each connection

* Compiles

* First thing sent on each new connection is the timeout

* Comments!

* Stop the connection on leaving play mode

* Add a "timeout on idle" config setting so Endpoint doesn't have to send it

* IP address check for Unity IP address and ROS IP address  (#80)

* Add Ip address check

* Adding condition for alphaumeric IP address

https://man7.org/linux/man-pages/man5/hosts.5.html

* Resolve conflicts

Resolve the conflicts to merge dev to main

* Update package.json (#87)

* Update version number in readme, and clean up some weird instructions (#89)

Co-authored-by: mpinol <mpinol@users.noreply.github.com>
Co-authored-by: flonou <florian.nouviale@inria.fr>
Co-authored-by: Devin Miller (Unity) <mrpropellers@users.noreply.github.com>
Co-authored-by: Amanda <31416491+at669@users.noreply.github.com>
Co-authored-by: vidurvij-Unity <60901103+vidurvij-Unity@users.noreply.github.com>
Co-authored-by: peifeng-unity <56408141+peifeng-unity@users.noreply.github.com>

* Remove deprecated files

Co-authored-by: LaurieCheers-unity <73140792+LaurieCheers-unity@users.noreply.github.com>
Co-authored-by: mpinol <mpinol@users.noreply.github.com>
Co-authored-by: flonou <florian.nouviale@inria.fr>
Co-authored-by: Devin Miller (Unity) <mrpropellers@users.noreply.github.com>
Co-authored-by: Amanda <31416491+at669@users.noreply.github.com>
Co-authored-by: vidurvij-Unity <60901103+vidurvij-Unity@users.noreply.github.com>
Co-authored-by: peifeng-unity <56408141+peifeng-unity@users.noreply.github.com>
@sdiao sdiao requested a review from peifeng-unity June 1, 2021 18:06
@sdiao sdiao merged commit 1588c15 into main Jun 1, 2021
sdiao added a commit that referenced this pull request Jun 1, 2021
* Add ROS# link (#55)

* Add ROS# link

* Fixing message name that should not take a capital first letter automatically (#47)

* Fixing message name that should not take a capital first letter automatically
* Adding warning when a message file name starts with a lowercase character

* AIRO-331 Code Cleanup and Testing Framework (#57)

* Moving package files into package subdirectory

* Adding tests and fixing Yamato config.

* Adding missing using statement to MessageParser

* RosMessageGeneration namespace change (#61)

* Amanda/read chunks (#62)

* Read message in chunks min

* Removing unpredictable DataAvailable check

* Configurable byte chun
k size

* Prevent infinite hang on reading message contents

* Wait for frame on data read retry

* PR Feedback

* Adding prebuilt ObjectRecognition and Octomap messages (#64)

* M prefix for all messages (#66)

* Topic list service (#72)

* Adding install instructions to README

Partially addressing issue #71 wherein a user couldn't find up-to-date instructions for installing the connector into a new project.

* Updating Contribution Content (#77)

* Contributing content commit

* Link fix

* PR feedback

* Adding PR template (#81)

* One persistent connection for all messages sent to Unity

* Read multiple messages from each connection

* Compiles

* First thing sent on each new connection is the timeout

* Comments!

* Stop the connection on leaving play mode

* Add a "timeout on idle" config setting so Endpoint doesn't have to send it

* IP address check for Unity IP address and ROS IP address  (#80)

* Add Ip address check

* Adding condition for alphaumeric IP address

https://man7.org/linux/man-pages/man5/hosts.5.html

* Resolve conflicts

Resolve the conflicts to merge dev to main

* Update package.json (#87)

* Update version number in readme, and clean up some weird instructions (#89)

* MDuration namespace change (#91)

* Minor link fix (#98)

* RosConnection 2.0 (#94)

* add changelog (#100)

add changelog

* Forum links to README, config.yml (#101)

* Laurie/connection status hud (#99)

* add test coverage (#102)

* Reducing character count for path to generated messages

The path from the package root to the root of the PregeneratedMessages
folder was 47 characters. From within the PickAndPlace project, the
fully qualified path including drive letter, path to workspace, and path
to its location in the package cache can easily exceed 200 characters,
especially for users with long names or deep workspace organization.
The maximum allowed path length for a fully qualified path in Windows is
260 characters, after which an IDE can not compile the assemblies for
source with too-long paths.

Moved Runtime/MessageGeneration/PregeneratedMessages to
Runtime/Messages, which saves 30 characters off the full path name. This
is a mitigation that can not fully solve the problem, but wil at least
reduce the number of cases for which the ROS-TCP-Endpoint assemblies
fail to compile due to path length.

Tested on my machine by manually renaming the directory in my
PackageCache.

* Add Linter (#103)

* Add editorconfig for formatting

* Use linter to format the package code

* Add pre-commit hook

* Fix line endings for markdown

Fix trailing-whitespace

* Remove ruby setup; Change to run pre-commit only on pull-requests

* Resolve conflicts (#106)

* Shuo/resolve conflict (#107)

* Merge 0.3.0 to main (#90)

* Add ROS# link (#55)

* Add ROS# link

* Fixing message name that should not take a capital first letter automatically (#47)

* Fixing message name that should not take a capital first letter automatically
* Adding warning when a message file name starts with a lowercase character

* AIRO-331 Code Cleanup and Testing Framework (#57)

* Moving package files into package subdirectory

* Adding tests and fixing Yamato config.

* Adding missing using statement to MessageParser

* RosMessageGeneration namespace change (#61)

* Amanda/read chunks (#62)

* Read message in chunks min

* Removing unpredictable DataAvailable check

* Configurable byte chun
k size

* Prevent infinite hang on reading message contents

* Wait for frame on data read retry

* PR Feedback

* Adding prebuilt ObjectRecognition and Octomap messages (#64)

* M prefix for all messages (#66)

* Topic list service (#72)

* Adding install instructions to README

Partially addressing issue #71 wherein a user couldn't find up-to-date instructions for installing the connector into a new project.

* Updating Contribution Content (#77)

* Contributing content commit

* Link fix

* PR feedback

* Adding PR template (#81)

* One persistent connection for all messages sent to Unity

* Read multiple messages from each connection

* Compiles

* First thing sent on each new connection is the timeout

* Comments!

* Stop the connection on leaving play mode

* Add a "timeout on idle" config setting so Endpoint doesn't have to send it

* IP address check for Unity IP address and ROS IP address  (#80)

* Add Ip address check

* Adding condition for alphaumeric IP address

https://man7.org/linux/man-pages/man5/hosts.5.html

* Resolve conflicts

Resolve the conflicts to merge dev to main

* Update package.json (#87)

* Update version number in readme, and clean up some weird instructions (#89)

Co-authored-by: Devin Miller (Unity) <mrpropellers@users.noreply.github.com>
Co-authored-by: Amanda <31416491+at669@users.noreply.github.com>
Co-authored-by: vidurvij-Unity <60901103+vidurvij-Unity@users.noreply.github.com>
Co-authored-by: peifeng-unity <56408141+peifeng-unity@users.noreply.github.com>

* Remove deprecated files

Co-authored-by: LaurieCheers-unity <73140792+LaurieCheers-unity@users.noreply.github.com>
Co-authored-by: Devin Miller (Unity) <mrpropellers@users.noreply.github.com>
Co-authored-by: Amanda <31416491+at669@users.noreply.github.com>
Co-authored-by: vidurvij-Unity <60901103+vidurvij-Unity@users.noreply.github.com>
Co-authored-by: peifeng-unity <56408141+peifeng-unity@users.noreply.github.com>

* add changelog meta file (#109)

* update version to 0.4.0 (#110)

* rremove stale merge

Co-authored-by: Devin Miller (Unity) <mrpropellers@users.noreply.github.com>
Co-authored-by: LaurieCheers-unity <73140792+LaurieCheers-unity@users.noreply.github.com>
Co-authored-by: Amanda <31416491+at669@users.noreply.github.com>
Co-authored-by: vidurvij-Unity <60901103+vidurvij-Unity@users.noreply.github.com>
Co-authored-by: peifeng-unity <56408141+peifeng-unity@users.noreply.github.com>
Co-authored-by: Devin Miller (Unity) <devin.miller@unity3d.com>
Co-authored-by: peifeng-unity <peifeng.jing@unity3d.com>

Co-authored-by: Devin Miller (Unity) <mrpropellers@users.noreply.github.com>
Co-authored-by: LaurieCheers-unity <73140792+LaurieCheers-unity@users.noreply.github.com>
Co-authored-by: Amanda <31416491+at669@users.noreply.github.com>
Co-authored-by: vidurvij-Unity <60901103+vidurvij-Unity@users.noreply.github.com>
Co-authored-by: peifeng-unity <56408141+peifeng-unity@users.noreply.github.com>
Co-authored-by: Devin Miller (Unity) <devin.miller@unity3d.com>
Co-authored-by: peifeng-unity <peifeng.jing@unity3d.com>
P3TE pushed a commit to P3TE/ROS-TCP-Connector that referenced this pull request Jul 13, 2021
* Add ROS# link (Unity-Technologies#55)

* Add ROS# link

* Fixing message name that should not take a capital first letter automatically (Unity-Technologies#47)

* Fixing message name that should not take a capital first letter automatically
* Adding warning when a message file name starts with a lowercase character

* AIRO-331 Code Cleanup and Testing Framework (Unity-Technologies#57)

* Moving package files into package subdirectory

* Adding tests and fixing Yamato config.

* Adding missing using statement to MessageParser

* RosMessageGeneration namespace change (Unity-Technologies#61)

* Amanda/read chunks (Unity-Technologies#62)

* Read message in chunks min

* Removing unpredictable DataAvailable check

* Configurable byte chun
k size

* Prevent infinite hang on reading message contents

* Wait for frame on data read retry

* PR Feedback

* Adding prebuilt ObjectRecognition and Octomap messages (Unity-Technologies#64)

* M prefix for all messages (Unity-Technologies#66)

* Topic list service (Unity-Technologies#72)

* Adding install instructions to README

Partially addressing issue Unity-Technologies#71 wherein a user couldn't find up-to-date instructions for installing the connector into a new project.

* Updating Contribution Content (Unity-Technologies#77)

* Contributing content commit

* Link fix

* PR feedback

* Adding PR template (Unity-Technologies#81)

* One persistent connection for all messages sent to Unity

* Read multiple messages from each connection

* Compiles

* First thing sent on each new connection is the timeout

* Comments!

* Stop the connection on leaving play mode

* Add a "timeout on idle" config setting so Endpoint doesn't have to send it

* IP address check for Unity IP address and ROS IP address  (Unity-Technologies#80)

* Add Ip address check

* Adding condition for alphaumeric IP address

https://man7.org/linux/man-pages/man5/hosts.5.html

* Resolve conflicts

Resolve the conflicts to merge dev to main

* Update package.json (Unity-Technologies#87)

* Update version number in readme, and clean up some weird instructions (Unity-Technologies#89)

* MDuration namespace change (Unity-Technologies#91)

* Minor link fix (Unity-Technologies#98)

* RosConnection 2.0 (Unity-Technologies#94)

* add changelog (Unity-Technologies#100)

add changelog

* Forum links to README, config.yml (Unity-Technologies#101)

* Laurie/connection status hud (Unity-Technologies#99)

* add test coverage (Unity-Technologies#102)

* Reducing character count for path to generated messages

The path from the package root to the root of the PregeneratedMessages
folder was 47 characters. From within the PickAndPlace project, the
fully qualified path including drive letter, path to workspace, and path
to its location in the package cache can easily exceed 200 characters,
especially for users with long names or deep workspace organization.
The maximum allowed path length for a fully qualified path in Windows is
260 characters, after which an IDE can not compile the assemblies for
source with too-long paths.

Moved Runtime/MessageGeneration/PregeneratedMessages to
Runtime/Messages, which saves 30 characters off the full path name. This
is a mitigation that can not fully solve the problem, but wil at least
reduce the number of cases for which the ROS-TCP-Endpoint assemblies
fail to compile due to path length.

Tested on my machine by manually renaming the directory in my
PackageCache.

* Add Linter (Unity-Technologies#103)

* Add editorconfig for formatting

* Use linter to format the package code

* Add pre-commit hook

* Fix line endings for markdown

Fix trailing-whitespace

* Remove ruby setup; Change to run pre-commit only on pull-requests

* Resolve conflicts (Unity-Technologies#106)

* Shuo/resolve conflict (Unity-Technologies#107)

* Merge 0.3.0 to main (Unity-Technologies#90)

* Add ROS# link (Unity-Technologies#55)

* Add ROS# link

* Fixing message name that should not take a capital first letter automatically (Unity-Technologies#47)

* Fixing message name that should not take a capital first letter automatically
* Adding warning when a message file name starts with a lowercase character

* AIRO-331 Code Cleanup and Testing Framework (Unity-Technologies#57)

* Moving package files into package subdirectory

* Adding tests and fixing Yamato config.

* Adding missing using statement to MessageParser

* RosMessageGeneration namespace change (Unity-Technologies#61)

* Amanda/read chunks (Unity-Technologies#62)

* Read message in chunks min

* Removing unpredictable DataAvailable check

* Configurable byte chun
k size

* Prevent infinite hang on reading message contents

* Wait for frame on data read retry

* PR Feedback

* Adding prebuilt ObjectRecognition and Octomap messages (Unity-Technologies#64)

* M prefix for all messages (Unity-Technologies#66)

* Topic list service (Unity-Technologies#72)

* Adding install instructions to README

Partially addressing issue Unity-Technologies#71 wherein a user couldn't find up-to-date instructions for installing the connector into a new project.

* Updating Contribution Content (Unity-Technologies#77)

* Contributing content commit

* Link fix

* PR feedback

* Adding PR template (Unity-Technologies#81)

* One persistent connection for all messages sent to Unity

* Read multiple messages from each connection

* Compiles

* First thing sent on each new connection is the timeout

* Comments!

* Stop the connection on leaving play mode

* Add a "timeout on idle" config setting so Endpoint doesn't have to send it

* IP address check for Unity IP address and ROS IP address  (Unity-Technologies#80)

* Add Ip address check

* Adding condition for alphaumeric IP address

https://man7.org/linux/man-pages/man5/hosts.5.html

* Resolve conflicts

Resolve the conflicts to merge dev to main

* Update package.json (Unity-Technologies#87)

* Update version number in readme, and clean up some weird instructions (Unity-Technologies#89)

Co-authored-by: Devin Miller (Unity) <mrpropellers@users.noreply.github.com>
Co-authored-by: Amanda <31416491+at669@users.noreply.github.com>
Co-authored-by: vidurvij-Unity <60901103+vidurvij-Unity@users.noreply.github.com>
Co-authored-by: peifeng-unity <56408141+peifeng-unity@users.noreply.github.com>

* Remove deprecated files

Co-authored-by: LaurieCheers-unity <73140792+LaurieCheers-unity@users.noreply.github.com>
Co-authored-by: Devin Miller (Unity) <mrpropellers@users.noreply.github.com>
Co-authored-by: Amanda <31416491+at669@users.noreply.github.com>
Co-authored-by: vidurvij-Unity <60901103+vidurvij-Unity@users.noreply.github.com>
Co-authored-by: peifeng-unity <56408141+peifeng-unity@users.noreply.github.com>

* add changelog meta file (Unity-Technologies#109)

* update version to 0.4.0 (Unity-Technologies#110)

* rremove stale merge

Co-authored-by: Devin Miller (Unity) <mrpropellers@users.noreply.github.com>
Co-authored-by: LaurieCheers-unity <73140792+LaurieCheers-unity@users.noreply.github.com>
Co-authored-by: Amanda <31416491+at669@users.noreply.github.com>
Co-authored-by: vidurvij-Unity <60901103+vidurvij-Unity@users.noreply.github.com>
Co-authored-by: peifeng-unity <56408141+peifeng-unity@users.noreply.github.com>
Co-authored-by: Devin Miller (Unity) <devin.miller@unity3d.com>
Co-authored-by: peifeng-unity <peifeng.jing@unity3d.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

9 participants