Automatic catchup to commit 5e5b50af23648f233d87b9770ac14e6f65efc3a9

5e5b50a Switch to 64bit build for raspberry
5f54312 Add build for raspberry pi
b8ddc56 Drop all cmake files from public
9029305 Bump version to 1.0.0
8897d37 Correct spelling warnings in release notes
bcc7598 Bump rstcloth for python 3.12 support
34bdce3 Add release notes
ffd1fbc Avoid setting default gateway on Linux
eb3752f Adapt documentation to precompiled binary
8289114 Update documentation in existing structure
c3388a8 Improve logging in sample app
bc4a062 Rename project to pnet
c25dcf3 Script to remove wireshark files without alarm frames from a directory
bb910db Limit the stationname command line argument length
932347b ignore slot and subslot in dpreal_data read req
ecc2f31 update rpc udp port management
36d9677 p-net - fix epm handling
e600fc3 p-net - fix behavior for duplicate connection requests
3c41db2 Add helper scripts to install

Based-On-Commit: 5e5b50af23648f233d87b9770ac14e6f65efc3a9
Change-Id: If261b8b9ae3db6d0e443a9b3842a030003d23cfe

Author: rt-labs bot

.docker/rbpi.Dockerfile

@@ -0,0 +1,11 @@
+FROM dockcross/linux-arm64-lts
+ENV DEFAULT_DOCKCROSS_IMAGE p-net-rbpi
+RUN apt-get install -y python3-venv
+
+RUN pip install --break-system-packages uv
+
+ARG BUILDER_UID=1001
+ARG BUILDER_GID=1001
+ARG BUILDER_USER=rtljenkins
+ARG BUILDER_GROUP=rtljenkins
+RUN BUILDER_UID=${BUILDER_GID} BUILDER_GID=${BUILDER_GID} BUILDER_USER=${BUILDER_USER} BUILDER_GROUP=${BUILDER_GROUP} /dockcross/entrypoint.sh echo "Setup jenkins user"

CHANGELOG.md

@@ -46,7 +46,7 @@ buy a license. See LICENSE.md for more details.
 
 ## Getting started
 
-See the tutorial in the documentation: [https://rt-labs.com/docs/p-net/tutorial.html](https://rt-labs.com/docs/p-net/tutorial.html)
+See the tutorial in the documentation: [https://docs.rt-labs.com/p-net/running_sample_app.html](https://docs.rt-labs.com/p-net/running_sample_app.html)
 
 Note that you need to include submodules when cloning:
 

README.md

@@ -1563,14 +1563,20 @@ PNET_EXPORT int pnet_pull_submodule (
  * before calling \a pnet_application_ready(). This includes all subslots in the
  * DAP slot (slot 0).
  *
+ * This function will copy the user data to the frame buffer, for sending to the PLC.
+ *
+ * Note that setting the IOPS to BAD will trigger an
+ * "Error: User data failure of hardware component" in the PLC, and it
+ * typically needs to be cleared manually.
+ *
  * @param net              InOut: The p-net stack instance
  * @param api              In:    The API.
  * @param slot             In:    The slot.
  * @param subslot          In:    The sub-slot.
- * @param p_data           In:    Data buffer. If NULL the data will not
- *                                be updated.
+ * @param p_data           In:    User buffer with data to be sent. If NULL the data
+ *                                will not be updated.
  * @param data_len         In:    Bytes in data buffer.
- * @param iops             In:    The device provider status.
+ * @param iops             In:    The device provider status (GOOD or BAD).
  *                                See pnet_ioxs_values_t
  * @return  0  if a sub-module data and IOPS was set.
  *          -1 if an error occurred.
@@ -1598,7 +1604,7 @@ PNET_EXPORT int pnet_input_set_data_and_iops (
  * @param api              In:    The API.
  * @param slot             In:    The slot.
  * @param subslot          In:    The sub-slot.
- * @param p_iocs           Out:   The controller consumer status.
+ * @param p_iocs           Out:   The controller consumer status (GOOD or BAD).
  *                                See pnet_ioxs_values_t
  * @return  0  if a sub-module IOCS was set.
  *          -1 if an error occurred.
@@ -1622,6 +1628,9 @@ PNET_EXPORT int pnet_input_get_iocs (
  * back data that has been set by \a pnet_input_set_data_and_iops() using this
  * function.
  *
+ * This function will copy the data from the frame buffer (which has data from the PLC)
+ * to the user buffer.
+ *
  * If a valid new data (and IOPS) frame has arrived from the IO-controller since
  * your last call to this function (regardless of the slot/subslot arguments)
  * then the flag \a p_new_flag is set to true, else it is set to false.
@@ -1639,7 +1648,7 @@ PNET_EXPORT int pnet_input_get_iocs (
  * @param slot             In:    The slot.
  * @param subslot          In:    The sub-slot.
  * @param p_new_flag       Out:   true if new data.
- * @param p_data           Out:   The received data.
+ * @param p_data           Out:   User buffer for the received data.
  * @param p_data_len       In:    Size of receive buffer.
  *                         Out:   Received number of data bytes.
  * @param p_iops           Out:   The controller provider status (IOPS).
@@ -1671,7 +1680,7 @@ PNET_EXPORT int pnet_output_get_data_and_iops (
  * @param api              In:    The API.
  * @param slot             In:    The slot.
  * @param subslot          In:    The sub-slot.
- * @param iocs             In:    The device consumer status.
+ * @param iocs             In:    The device consumer status (GOOD or BAD).
  *                                See pnet_ioxs_values_t
  * @return  0  if a sub-module IOCS was set.
  *          -1 if an error occurred.

include/pnet_api.h

@@ -16,24 +16,24 @@
 #ifndef PNET_VERSION_H
 #define PNET_VERSION_H
 
-#cmakedefine PROFINET_GIT_REVISION "@PROFINET_GIT_REVISION@"
+#cmakedefine PNET_GIT_REVISION "@PNET_GIT_REVISION@"
 
-#if !defined(PNET_VERSION_BUILD) && defined(PROFINET_GIT_REVISION)
-#define PNET_VERSION_BUILD PROFINET_GIT_REVISION
+#if !defined(PNET_VERSION_BUILD) && defined(PNET_GIT_REVISION)
+#define PNET_VERSION_BUILD PNET_GIT_REVISION
 #endif
 
 /* clang-format-off */
 
-#define PNET_VERSION_MAJOR @PROFINET_VERSION_MAJOR@
-#define PNET_VERSION_MINOR @PROFINET_VERSION_MINOR@
-#define PNET_VERSION_PATCH @PROFINET_VERSION_PATCH@
+#define PNET_VERSION_MAJOR @PNET_VERSION_MAJOR@
+#define PNET_VERSION_MINOR @PNET_VERSION_MINOR@
+#define PNET_VERSION_PATCH @PNET_VERSION_PATCH@
 
 #if defined(PNET_VERSION_BUILD)
 #define PNET_VERSION \
-   "@PROFINET_VERSION_MAJOR@.@PROFINET_VERSION_MINOR@.@PROFINET_VERSION_PATCH@+" PNET_VERSION_BUILD
+   "@PNET_VERSION_MAJOR@.@PNET_VERSION_MINOR@.@PNET_VERSION_PATCH@+" PNET_VERSION_BUILD
 #else
 #define PNET_VERSION \
-   "@PROFINET_VERSION_MAJOR@.@PROFINET_VERSION_MINOR@.@PROFINET_VERSION_PATCH@"
+   "@PNET_VERSION_MAJOR@.@PNET_VERSION_MINOR@.@PNET_VERSION_PATCH@"
 #endif
 
 /* clang-format-on */