Skip to content

Commit 0c057d4

Browse files
0w8States0w8States
authored
Merge pull request #3 from Beckhoff-USA-Community/v2.0.0
V2.0.0
2 parents 41f0311 + 77bc09c commit 0c057d4

File tree

89 files changed

+10627
-93
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

89 files changed

+10627
-93
lines changed

‎.github/workflows/generate-docs-pdf.yml‎

Lines changed: 133 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
1+
name: Generate Documentation PDFs
2+
3+
on:
4+
push:
5+
branches: ["main", "v2.0.0"]
6+
paths:
7+
- 'gh_pages/_docs/**'
8+
- 'gh_pages/assets/pdf-template/**'
9+
- '.github/workflows/generate-docs-pdf.yml'
10+
workflow_dispatch:
11+
12+
permissions:
13+
contents: write
14+
15+
jobs:
16+
generate-pdfs:
17+
runs-on: ubuntu-latest
18+
steps:
19+
- name: Checkout repository
20+
uses: actions/checkout@v4
21+
with:
22+
fetch-depth: 0
23+
24+
- name: Install Pandoc and LaTeX
25+
run: |
26+
sudo apt-get update
27+
sudo apt-get install -y pandoc texlive-latex-base texlive-fonts-recommended texlive-fonts-extra texlive-latex-extra
28+
29+
- name: Create PDF output directory
30+
run: |
31+
mkdir -p gh_pages/assets/pdf
32+
33+
- name: Generate Getting Started PDF
34+
run: |
35+
pandoc gh_pages/_docs/getting-started.md \
36+
-o gh_pages/assets/pdf/getting-started.pdf \
37+
--from markdown \
38+
--template gh_pages/assets/pdf-template/template.tex \
39+
--variable documentclass=article \
40+
--variable geometry:margin=1in \
41+
--variable fontsize=11pt \
42+
--variable colorlinks=true \
43+
--variable linkcolor=red \
44+
--variable urlcolor=red \
45+
--toc \
46+
--toc-depth=2 \
47+
--pdf-engine=pdflatex \
48+
--metadata title="Event Video Playback - Getting Started" \
49+
--metadata author="Beckhoff USA Community"
50+
51+
- name: Generate PLC Library Usage PDF
52+
run: |
53+
pandoc gh_pages/_docs/plc-usage.md \
54+
-o gh_pages/assets/pdf/plc-usage.pdf \
55+
--from markdown \
56+
--template gh_pages/assets/pdf-template/template.tex \
57+
--variable documentclass=article \
58+
--variable geometry:margin=1in \
59+
--variable fontsize=11pt \
60+
--variable colorlinks=true \
61+
--variable linkcolor=red \
62+
--variable urlcolor=red \
63+
--toc \
64+
--toc-depth=2 \
65+
--pdf-engine=pdflatex \
66+
--metadata title="Event Video Playback - PLC Library Usage" \
67+
--metadata author="Beckhoff USA Community"
68+
69+
- name: Generate Service Configuration PDF
70+
run: |
71+
pandoc gh_pages/_docs/service-config.md \
72+
-o gh_pages/assets/pdf/service-config.pdf \
73+
--from markdown \
74+
--template gh_pages/assets/pdf-template/template.tex \
75+
--variable documentclass=article \
76+
--variable geometry:margin=1in \
77+
--variable fontsize=11pt \
78+
--variable colorlinks=true \
79+
--variable linkcolor=red \
80+
--variable urlcolor=red \
81+
--toc \
82+
--toc-depth=2 \
83+
--pdf-engine=pdflatex \
84+
--metadata title="Event Video Playback - Service Configuration" \
85+
--metadata author="Beckhoff USA Community"
86+
87+
- name: Generate HMI Usage PDF
88+
run: |
89+
pandoc gh_pages/_docs/hmi-usage.md \
90+
-o gh_pages/assets/pdf/hmi-usage.pdf \
91+
--from markdown \
92+
--template gh_pages/assets/pdf-template/template.tex \
93+
--variable documentclass=article \
94+
--variable geometry:margin=1in \
95+
--variable fontsize=11pt \
96+
--variable colorlinks=true \
97+
--variable linkcolor=red \
98+
--variable urlcolor=red \
99+
--toc \
100+
--toc-depth=2 \
101+
--pdf-engine=pdflatex \
102+
--metadata title="Event Video Playback - HMI NuGet Package Usage" \
103+
--metadata author="Beckhoff USA Community"
104+
105+
- name: Generate Complete Documentation PDF
106+
run: |
107+
pandoc gh_pages/_docs/getting-started.md \
108+
gh_pages/_docs/plc-usage.md \
109+
gh_pages/_docs/service-config.md \
110+
gh_pages/_docs/hmi-usage.md \
111+
-o gh_pages/assets/pdf/complete-documentation.pdf \
112+
--from markdown \
113+
--template gh_pages/assets/pdf-template/template.tex \
114+
--variable documentclass=report \
115+
--variable geometry:margin=1in \
116+
--variable fontsize=11pt \
117+
--variable colorlinks=true \
118+
--variable linkcolor=red \
119+
--variable urlcolor=red \
120+
--toc \
121+
--toc-depth=2 \
122+
--pdf-engine=pdflatex \
123+
--metadata title="Event Video Playback - Complete Documentation" \
124+
--metadata author="Beckhoff USA Community" \
125+
--metadata date="$(date +'%B %Y')"
126+
127+
- name: Commit PDFs to repository
128+
run: |
129+
git config --local user.email "github-actions[bot]@users.noreply.github.com"
130+
git config --local user.name "github-actions[bot]"
131+
git add gh_pages/assets/pdf/*.pdf
132+
git diff --staged --quiet || git commit -m "Generate documentation PDFs [skip ci]"
133+
git push

‎.github/workflows/pages.yml‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
name: Deploy Jekyll site to GitHub Pages
2+
3+
on:
4+
push:
5+
branches: ["main", "v2.0.0"]
6+
paths:
7+
- 'gh_pages/**'
8+
- '.github/workflows/pages.yml'
9+
workflow_dispatch:
10+
11+
permissions:
12+
contents: read
13+
pages: write
14+
id-token: write
15+
16+
concurrency:
17+
group: "pages"
18+
cancel-in-progress: false
19+
20+
jobs:
21+
build:
22+
runs-on: ubuntu-latest
23+
steps:
24+
- name: Checkout
25+
uses: actions/checkout@v4
26+
27+
- name: Setup Ruby
28+
uses: ruby/setup-ruby@v1
29+
with:
30+
ruby-version: '3.3'
31+
bundler-cache: true
32+
working-directory: ./gh_pages
33+
34+
- name: Setup Pages
35+
id: pages
36+
uses: actions/configure-pages@v4
37+
38+
- name: Build with Jekyll
39+
working-directory: ./gh_pages
40+
run: bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}"
41+
env:
42+
JEKYLL_ENV: production
43+
44+
- name: Upload artifact
45+
uses: actions/upload-pages-artifact@v3
46+
with:
47+
path: ./gh_pages/_site
48+
49+
deploy:
50+
environment:
51+
name: github-pages
52+
url: ${{ steps.deployment.outputs.page_url }}
53+
runs-on: ubuntu-latest
54+
needs: build
55+
steps:
56+
- name: Deploy to GitHub Pages
57+
id: deployment
58+
uses: actions/deploy-pages@v4

‎README.md‎

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,11 @@
22

33
This repository includes both the source files and the release package for the TwinCAT Event Video Playback package. The package provides an easy to use PLC interface for assembling images captured with TwinCAT Vision into a single video file. When the video file is created, a corresponding alarm event is logged into the TwinCAT Event Logger for later viewing. In addition, an HMI Control component is supplied for easy viewing and playback of logged video events on TwinCAT HMI.
44

5+
**WARNING: Remove any installs from the legacy TC_EventVideoPlayback before using the new 4026 version**
6+
57
## Quick Start
68

7-
**For end users**: Instead of building from source, download the installer from the [Releases section](https://github.com/Beckhoff-USA-Community/EventVideoPlayback/releases). The release package includes:
8-
- Sample PLC project
9-
- Sample HMI project
10-
- PLC library
11-
- Windows service installer
9+
**For end users**: Instead of building from source, connect to the [Beckhoff USA Communtiy package](https://packages.beckhoff-usa-community.com/) feed like you would normally with Beckhoff Official Packages.
1210

1311
**For developers**: See [Building from Source](#building-from-source) below.
1412

‎docs/images/Camera-Alam-Icon-Color-Small.png‎

-21.2 KB
Binary file not shown.

‎docs/images/Camera-Alam-Icon-Color.png‎

-710 KB
Binary file not shown.

‎docs/images/Camera-Alarm-Icon.ico‎

-169 KB
Binary file not shown.

‎docs/images/Camera-Alarm-Icon.png‎

-141 KB
Binary file not shown.

‎docs/images/EventVideoPlayback.png‎

-1.21 MB
Binary file not shown.

‎docs/images/EventVideoPlayback_512x512.png‎

-194 KB
Binary file not shown.

‎docs/images/alarmIcon.png‎

-21.5 KB
Binary file not shown.

0 commit comments

Comments
 (0)