Add axserialport example

Co-authored-by: Mar Balibrea Rull <[email protected]> Co-authored-by: Mattias Kindborg <[email protected]> Co-authored-by: Angelo DelliSanti <[email protected]>
AxisCommunications · Nov 20, 2023 · 6cd2d1e · 6cd2d1e
1 parent eee42ef
commit 6cd2d1e
Show file tree

Hide file tree

Showing 9 changed files with 690 additions and 0 deletions.
diff --git a/.github/workflows/axserialport.yml b/.github/workflows/axserialport.yml
@@ -0,0 +1,32 @@
+name: Build axserialport application
+on:
+  workflow_dispatch:
+  push:
+    paths:
+      - 'axserialport/**'
+      - '!axserialport/README.md'
+      - '.github/workflows/axserialport.yml'
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        axis-os: ["11.7.57"]
+        arch: ["armv7hf", "aarch64"]
+    env:
+      EXREPO: acap-native-examples
+      EXNAME: axserialport
+    steps:
+      - uses: actions/checkout@v4
+      - uses: docker/setup-buildx-action@v3
+
+      - name: Build ${{ env.EXNAME }} application
+        env:
+          imagetag: ${{ env.EXREPO }}_${{ env.EXNAME }}:${{ matrix.arch }}
+        run: |
+          docker image rm -f $imagetag
+          cd $EXNAME
+          docker build --no-cache --tag $imagetag --build-arg ARCH=${{ matrix.arch }} .
+          docker cp $(docker create $imagetag):/opt/app ./build
+          cd ..
+          docker image rm -f $imagetag
diff --git a/README.md b/README.md
@@ -24,6 +24,8 @@ Below is the list of examples available in the repository.
   - The example code is written in C which illustrates both how to subscribe to different events and how to send an event.
 - [axoverlay](./axoverlay/)
   - The example code is written in C which illustrates how to draw plain boxes and text as overlays in a stream.
+- [axserialport](./axserialport/)
+  - This example is written in C and shows the use of the serial port API.
 - [axstorage](./axstorage/)
   - The example code is written in C which shows how to use available storage devices.
 - [container-example](./container-example/)

diff --git a/axserialport/Dockerfile b/axserialport/Dockerfile
@@ -0,0 +1,17 @@
+# syntax=docker/dockerfile:1
+
+ARG ARCH=armv7hf
+ARG VERSION=1.11
+ARG UBUNTU_VERSION=22.04
+ARG REPO=axisecp
+ARG SDK=acap-native-sdk
+
+FROM ${REPO}/${SDK}:${VERSION}-${ARCH}-ubuntu${UBUNTU_VERSION}
+
+# Building the ACAP application
+COPY ./app /opt/app/
+WORKDIR /opt/app
+RUN <<EOF
+. /opt/axis/acapsdk/environment-setup*
+acap-build .
+EOF
diff --git a/axserialport/README.md b/axserialport/README.md
@@ -0,0 +1,116 @@
+# How to communicate with serial ports in an ACAP application
+
+This guide explains how to build an ACAP application that uses the axserialport API. This example illustrates how to enable the serial port and set configuration parameters with the API. Additionally, it uses the [GLib IOChannel](https://docs.gtk.org/glib/struct.IOChannel.html)'s methods to communicate between two available ports in the Axis product.
+
+This program requires a serial loopback cable in order to function properly. This is how it should look like:
+![Loopback diagram](assets/loopback-diagram.png)
+
+## Getting started
+
+These instructions will guide you on how to execute the code. Below is the structure and scripts used in the example:
+
+```sh
+axserialport
+├── app
+│   ├── axserialport.c
+│   ├── LICENSE
+│   ├── Makefile
+│   └── manifest.json
+├── Dockerfile
+└── README.md
+```
+
+- **app/axserialport.c** - Application to show API in C.
+- **app/LICENSE** - Text file which lists all open source licensed source code distributed with the application.
+- **app/Makefile** - Makefile containing the build and link instructions for building the ACAP application.
+- **app/manifest.json** - Defines the application and its configuration.
+- **Dockerfile** - Docker file with the specified Axis toolchain and API container to build the example specified.
+- **README.md** - Step by step instructions on how to run the example.
+
+### How to run the code
+
+Below is the step by step instructions on how to execute the program. So basically starting with the generation of the .eap file to running it on a device.
+
+#### Build the application
+
+Standing in your working directory run the following commands:
+
+> [!NOTE]
+>
+> Depending on the network you are connected to, you may need to add proxy settings.
+> The file that needs these settings is: `~/.docker/config.json`. For reference please see
+> https://docs.docker.com/network/proxy and a
+> [script for Axis devices](https://axiscommunications.github.io/acap-documentation/docs/develop/build-install-run.html#configure-network-proxy-settings) in the ACAP documentation.
+
+```sh
+docker build --tag <APP_IMAGE> .
+```
+
+`<APP_IMAGE>` is the name to tag the image with, e.g., `axserialport:1.0`
+
+Default architecture is **armv7hf**. To build for **aarch64** it's possible to
+update the *ARCH* variable in the Dockerfile or to set it in the docker build
+command via build argument:
+
+```sh
+docker build --build-arg ARCH=aarch64 --tag <APP_IMAGE> .
+```
+
+Copy the result from the container image to a local directory called `build`:
+
+```sh
+docker cp $(docker create <APP_IMAGE>):/opt/app ./build
+```
+
+The working directory now contains a build folder with the following files:
+
+```sh
+axserialport
+build
+├── Makefile
+├── manifest.json
+├── package.conf
+├── package.conf.orig
+├── param.conf
+├── axserialport*
+├── axserialport_1_0_0_armv7hf.eap
+├── axserialport_1_0_0_LICENSE.txt
+├── axserialport.c
+└── LICENSE
+```
+
+- **manifest.json** - Defines the application and its configuration.
+- **package.conf** - Defines the application and its configuration.
+- **package.conf.orig** - Defines the application and its configuration, original file.
+- **param.conf** - File containing additional application parameters.
+- **axserialport*** - Application executable binary file.
+- **axserialport_1_0_0_armv7hf.eap** - Application package .eap file.
+- **axserialport_1_0_0_LICENSE.txt** - Copy of LICENSE file.
+
+#### Install your application
+
+Installing your application on an Axis device is as simple as:
+
+1. In your browser, navigate to `http://<DEVICE_IP>/#settings/apps` where `<DEVICE_IP>` is the IP address of your device
+2. Click on the tab **App** in the device GUI
+3. Click the **(+)** button and browse to the newly built **axserialport_1_0_0_armv7hf.eap**
+4. Click **Install**
+5. Run the application by enabling the **Start** switch
+
+#### The expected output
+
+Application log can be found directly at `http://<DEVICE_IP>/axis-cgi/admin/systemlog.cgi?appname=axserialport` or by clicking on the "**App log**" link in the device GUI.
+
+```sh
+----- Contents of SYSTEM_LOG for 'axserialport' -----
+11:39:55.366 [ INFO ] axserialport[1423]: Starting AxSerialPort application
+11:40:09.784 [ NOTICE  ] axserialport[1423]: incoming_data() timestamp: 00:10
+11:40:09.784 [ NOTICE  ] axserialport[1423]: send_timer_data() wrote 2 bytes, status:'G_IO_STATUS_NORMAL'
+11:40:19.784 [ NOTICE  ] axserialport[1423]: incoming_data() timestamp: 00:20
+11:40:19.784 [ NOTICE  ] axserialport[1423]: send_timer_data() wrote 2 bytes, status:'G_IO_STATUS_NORMAL'
+...
+```
+
+## License
+
+**[Apache License 2.0](../LICENSE)**
diff --git a/axserialport/app/LICENSE b/axserialport/app/LICENSE
@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        https://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2023 Axis Communications AB
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       https://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.