Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CON-285 merge docs and setup.py info back to master. #160

Merged
merged 46 commits into from
Dec 15, 2022
Merged

CON-285 merge docs and setup.py info back to master. #160

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
46 commits
Select commit Hold shift + click to select a range
1d51d71
CON-92, CON-200 merge to 1.1.1 (#85)
samuelraeburn Sep 30, 2021
635e8f3
Feature/con 191 (#83) (#86)
samuelraeburn Oct 6, 2021
18897de
CON-92: Handle case in obtaining version where Connector was git clon…
samuelraeburn Oct 6, 2021
18412df
PLATFORMS-2289. Adding macOS 11 to Connector PY release notes.
adelleolson Nov 1, 2021
5b287e6
Merge pull request #98 from rticommunity/feature/PLATFORMS-2289-ConPY…
adelleolson Nov 9, 2021
d7869cc
HMAINT-235: Handle case where build ID contains 4 digits (#96) (#97)
samuelraeburn Nov 9, 2021
995ca45
#fix HMAINT-202 -- update libraries for 1.2.0, set version for test.p…
alvinkrebs Nov 15, 2021
5c72d0d
HMAINT-202 -- correct rc1 version string (#103)
alvinkrebs Nov 18, 2021
f59b0a4
HMAINT-202 -- set version to rc2 for testing (#107)
alvinkrebs Nov 19, 2021
09ca8ab
CON-252: updating links from current to 6.1.1, py
rkorte Nov 19, 2021
f4cf920
CORE-11993: canonical url added for python connector
rkorte Nov 19, 2021
aece111
CON-251: connector py release notes for 6.1.1/1.2.0
rkorte Nov 18, 2021
84482cd
CON-251: 1.2.0 doc changes
samuelraeburn Nov 19, 2021
a8ebc0f
Merge pull request #109 from rticommunity/feature/CORE-11993-120-cher…
rkorte Nov 22, 2021
27f55be
Merge pull request #108 from rticommunity/feature/CON-252-py-cherrypi…
rkorte Nov 22, 2021
c009f76
CON-251: added missing release note and fixed canonical formatting error
rkorte Nov 23, 2021
f454c82
Merge pull request #110 from rticommunity/feature/CON-251-py-cherrypi…
rkorte Nov 24, 2021
c208b05
Merge branch 'release/connector/1.2.0' into feature/CON-251-py-more-c…
rkorte Nov 24, 2021
af8daaa
Merge pull request #115 from rticommunity/feature/CON-251-py-more-che…
rkorte Nov 24, 2021
2b1d425
CON-253: Document bug in numpy on aarch64 (#113) (#114)
samuelraeburn Nov 29, 2021
18e203e
CON-234: fixing link to Python API reference
rkorte Nov 22, 2021
49230ca
CON-234: changed python api link to go to github
rkorte Nov 25, 2021
5ca1f52
Merge pull request #116 from rticommunity/feature/CON-234-cherry-pick…
rkorte Dec 2, 2021
53fb796
HMAINT-202 -- set version string to 1.2.0 (#118)
alvinkrebs Dec 15, 2021
b051d13
CON-251: applying PAM updates to supported platforms
rkorte Nov 30, 2021
ffc11e0
CON-251. Corrected the Jira # mentioned for CON-200 in what's fixed. …
adelleolson Dec 15, 2021
9bcde61
CON-251. Corrected wording of what's tested.
adelleolson Dec 15, 2021
73f6d5e
Merge pull request #119 from rticommunity/feature/CON-251-platforms-t…
rkorte Dec 15, 2021
efd8ae9
#fix HMAINT-202 -- new connector libraries for python, base on DDS 6.…
alvinkrebs Jan 5, 2022
0056cb4
#fix HMAINT-202 -- corrected library git references for py, base on D…
alvinkrebs Jan 5, 2022
52a1196
#fix HMAINT-202 -- clean out old libraries for py. (#123)
alvinkrebs Jan 5, 2022
d1b5f97
CON-257: adding Lua vulnerability assessment to Connector 1.2.0 doc
rkorte Feb 1, 2022
f7d912b
CON-257: updating vulnerability assessment section for python
rkorte Feb 5, 2022
8188a5a
CON-257: updated release notes and copyright
rkorte Feb 10, 2022
d460667
Merge pull request #128 from rticommunity/doc/CON-257-release120
rkorte Feb 22, 2022
da4af72
#fix HMAINT-202 -- new connector libraries for python, base on DDS 6.…
alvinkrebs Mar 11, 2022
1f0e14c
#fix HMAINT-202 -- final version string 1.2.0 (#132)
alvinkrebs Apr 12, 2022
32ff822
CON-276: Updated loading of redist + commit of submodule (#144) (#146)
samuelraeburn Oct 26, 2022
34d01dc
Feature/con 272 276 support (#148)
samuelraeburn Oct 26, 2022
1a0f8f1
CON-280-support, change version number to 1.2.2 in support/connector/…
alvinkrebs Oct 28, 2022
3fb7163
CON-278 -- rc2 with libraries from 20221028 (#154)
alvinkrebs Nov 2, 2022
e26d0ea
HMAINT-747: updating 1.2.0 version to 1.2.2 and 6.1.1 URLs to 6.1.2
rkorte Nov 18, 2022
2641b77
Merge pull request #156 from rticommunity/doc/HMAINT-747-py
rkorte Nov 18, 2022
f45cb45
#fix CON-279 -- rc3 for new 20221111 libs ... (#157)
alvinkrebs Nov 18, 2022
a02092b
CON-278 -- final version string for 1.2.2 (#159)
alvinkrebs Dec 14, 2022
4cbc5ee
CON-285 -- merge release/connector/1.2.2 back to master ...
Dec 14, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@
author = 'Real-Time Innovations, Inc.'

# The full version, including alpha/beta/rc tags
version = '1.2.0'
release = '1.2.0'
version = '1.2.2'
release = '1.2.2'

master_doc = 'index'

Expand Down
20 changes: 10 additions & 10 deletions docs/configuration.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ that includes the definition of domains, *DomainParticipants*, *Topics*,

*Connector* uses the XML schema defined by RTI's
`XML-Based Application Creation feature
<https://community.rti.com/static/documentation/connext-dds/6.1.1/doc/manuals/connext_dds_professional/xml_application_creation/index.htm>`__.
<https://community.rti.com/static/documentation/connext-dds/6.1.2/doc/manuals/connext_dds_professional/xml_application_creation/index.htm>`__.

.. hint::
The *Connext DDS* C, C++, Java and .NET APIs can also load the same XML files
Expand Down Expand Up @@ -77,11 +77,11 @@ and ``shapesize``:
Types are associated with *Topics*, as explained in the next section, :ref:`Domain Library`.

.. hint::
You can define your types in IDL and convert them to XML with `rtiddsgen <https://community.rti.com/static/documentation/connext-dds/6.1.1/doc/manuals/connext_dds_professional/code_generator/users_manual/index.htm>`__.
You can define your types in IDL and convert them to XML with `rtiddsgen <https://community.rti.com/static/documentation/connext-dds/6.1.2/doc/manuals/connext_dds_professional/code_generator/users_manual/index.htm>`__.
For example: ``rtiddsgen -convertToXml MyTypes.idl``

For more information about defining types, see
`Creating User Data Types with XML <https://community.rti.com/static/documentation/connext-dds/6.1.1/doc/manuals/connext_dds_professional/users_manual/index.htm#users_manual/Creating_User_Data_Types_with_Extensible.htm>`__
`Creating User Data Types with XML <https://community.rti.com/static/documentation/connext-dds/6.1.2/doc/manuals/connext_dds_professional/users_manual/index.htm#users_manual/Creating_User_Data_Types_with_Extensible.htm>`__
in the *RTI Connext DDS Core Libraries User's Manual*.

For more information about accessing data samples, see :ref:`Accessing the data`.
Expand All @@ -91,10 +91,10 @@ Domain library

A domain library is a collection of domains. A domain specifies:

* A `domain id <https://community.rti.com/static/documentation/connext-dds/6.1.1/doc/manuals/connext_dds_professional/users_manual/index.htm#users_manual/ChoosingDomainID.htm>`__.
* A `domain id <https://community.rti.com/static/documentation/connext-dds/6.1.2/doc/manuals/connext_dds_professional/users_manual/index.htm#users_manual/ChoosingDomainID.htm>`__.
* A set of registered types (from a subset of the types in ``<types>``).
A registered type can have a local name.
* A set of `topics <https://community.rti.com/static/documentation/connext-dds/6.1.1/doc/manuals/connext_dds_professional/users_manual/index.htm#users_manual/WorkingWithTopics.htm>`__,
* A set of `topics <https://community.rti.com/static/documentation/connext-dds/6.1.2/doc/manuals/connext_dds_professional/users_manual/index.htm#users_manual/WorkingWithTopics.htm>`__,
which are used by *DataReaders* and *DataWriters*.

.. code-block:: xml
Expand All @@ -108,7 +108,7 @@ A domain library is a collection of domains. A domain specifies:
</domain_library>

For more information about the format of a domain library, see
`XML-Based Application Creation: Domain Library <https://community.rti.com/static/documentation/connext-dds/6.1.1/doc/manuals/connext_dds_professional/xml_application_creation/index.htm#xml_based_app_creation_guide/UnderstandingXMLBased/DomainLibrary.htm>`__.
`XML-Based Application Creation: Domain Library <https://community.rti.com/static/documentation/connext-dds/6.1.2/doc/manuals/connext_dds_professional/xml_application_creation/index.htm#xml_based_app_creation_guide/UnderstandingXMLBased/DomainLibrary.htm>`__.

Participant library
~~~~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -142,12 +142,12 @@ an :class:`Input`, as described in :ref:`Reading data (Input)`.

For more information about the format of a participant library, see
`XML-Based Application Creation: Participant Library
<https://community.rti.com/static/documentation/connext-dds/6.1.1/doc/manuals/connext_dds_professional/xml_application_creation/index.htm#xml_based_app_creation_guide/UnderstandingXMLBased/ParticipantLibrary.htm>`__.
<https://community.rti.com/static/documentation/connext-dds/6.1.2/doc/manuals/connext_dds_professional/xml_application_creation/index.htm#xml_based_app_creation_guide/UnderstandingXMLBased/ParticipantLibrary.htm>`__.

Quality of service
~~~~~~~~~~~~~~~~~~

All DDS entities have an associated `quality of service (QoS) <https://community.rti.com/static/documentation/connext-dds/6.1.1/doc/manuals/connext_dds_professional/users_manual/index.htm#users_manual/QosPolicies.htm>`__.
All DDS entities have an associated `quality of service (QoS) <https://community.rti.com/static/documentation/connext-dds/6.1.2/doc/manuals/connext_dds_professional/users_manual/index.htm#users_manual/QosPolicies.htm>`__.
There are several ways to configure it.

You can define a QoS profile and make it the default. The following example
Expand Down Expand Up @@ -234,12 +234,12 @@ profile is equivalent to *MyQosProfile* above:

You can read more in the *RTI Connext DDS Core Libraries User's Manual*,
`Configuring QoS with XML
<https://community.rti.com/static/documentation/connext-dds/6.1.1/doc/manuals/connext_dds_professional/users_manual/index.htm#users_manual/XMLConfiguration.htm>`__.
<https://community.rti.com/static/documentation/connext-dds/6.1.2/doc/manuals/connext_dds_professional/users_manual/index.htm#users_manual/XMLConfiguration.htm>`__.

Logging
^^^^^^^

Logging can be configured as explained in `Configuring Logging via XML <https://community.rti.com/static/documentation/connext-dds/6.1.1/doc/manuals/connext_dds_professional/users_manual/index.htm#users_manual/Configuring_Logging_via_XML1.htm>`__.
Logging can be configured as explained in `Configuring Logging via XML <https://community.rti.com/static/documentation/connext-dds/6.1.2/doc/manuals/connext_dds_professional/users_manual/index.htm#users_manual/Configuring_Logging_via_XML1.htm>`__.

For example, to increase the logging verbosity from the default (ERROR) to
WARNING, define a ``qos_profile`` with the attribute
Expand Down
4 changes: 2 additions & 2 deletions docs/connector.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ To create a new :class:`Connector`, pass an XML file and a configuration name:
connector = rti.Connector("MyParticipantLibrary::MyParticipant", "ShapeExample.xml");

The XML file defines your types, QoS profiles, and DDS Entities. *Connector*
uses the XML schema of `RTI's XML-Based Application Creation <https://community.rti.com/static/documentation/connext-dds/6.1.1/doc/manuals/connext_dds_professional/xml_application_creation/index.htm#xml_based_app_creation_guide/UnderstandingXMLBased/XMLTagsConfigEntities.htm>`__.
uses the XML schema of `RTI's XML-Based Application Creation <https://community.rti.com/static/documentation/connext-dds/6.1.2/doc/manuals/connext_dds_professional/xml_application_creation/index.htm#xml_based_app_creation_guide/UnderstandingXMLBased/XMLTagsConfigEntities.htm>`__.

The previous code loads the ``<domain_participant>`` named *MyParticipant* in
the ``<domain_participant_library>`` named *MyParticipantLibrary*, which is defined in the
Expand All @@ -40,7 +40,7 @@ When you create a :class:`Connector`, the DDS *DomainParticipant* that you selec
and all its contained entities (*Topics*, *Subscribers*, *DataReaders*,
*Publishers*, *DataWriters*) are created.

For more information about the DDS entities, see `Core Concepts <https://community.rti.com/static/documentation/connext-dds/6.1.1/doc/manuals/connext_dds_professional/users_manual/index.htm#users_manual/PartCoreConcepts.htm>`__
For more information about the DDS entities, see `Core Concepts <https://community.rti.com/static/documentation/connext-dds/6.1.2/doc/manuals/connext_dds_professional/users_manual/index.htm#users_manual/PartCoreConcepts.htm>`__
in the *RTI Connext DDS Core Libraries User's Manual*.

.. note::
Expand Down
2 changes: 1 addition & 1 deletion docs/data.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -432,7 +432,7 @@ To clear a member, set it to ``None`` explicitly::


For more information about optional members in DDS, see
`Optional Members <https://community.rti.com/static/documentation/connext-dds/6.1.1/doc/manuals/connext_dds_professional/extensible_types_guide/index.htm#extensible_types/Optional_Members.htm>`__
`Optional Members <https://community.rti.com/static/documentation/connext-dds/6.1.2/doc/manuals/connext_dds_professional/extensible_types_guide/index.htm#extensible_types/Optional_Members.htm>`__
in the *Extensible Types Guide*.

Accessing unions
Expand Down
Loading