[pull] master from JuliaBerry:master

.github/workflows/CI.yml

@@ -0,0 +1,73 @@
+name: CI
+on:
+  - push
+  - pull_request
+jobs:
+  test:
+    name: Julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        version:
+          - 'lts'
+          - '1'
+        os:
+          - ubuntu-latest
+        arch:
+          - x64
+    steps:
+      - uses: actions/checkout@v4
+      - uses: julia-actions/setup-julia@v2
+        with:
+          version: ${{ matrix.version }}
+          arch: ${{ matrix.arch }}
+      - uses: actions/cache@v4
+        env:
+          cache-name: cache-artifacts
+        with:
+          path: ~/.julia/artifacts
+          key: ${{ runner.os }}-test-${{ env.cache-name }}-${{ hashFiles('**/Project.toml') }}
+          restore-keys: |
+            ${{ runner.os }}-test-${{ env.cache-name }}-
+            ${{ runner.os }}-test-
+            ${{ runner.os }}-
+      - uses: julia-actions/julia-buildpkg@latest
+      - run: |
+          git config --global user.name Tester
+          git config --global user.email [email protected]
+      - uses: julia-actions/julia-runtest@latest
+        continue-on-error: ${{ matrix.version == 'nightly' }}
+      # - uses: julia-actions/julia-processcoverage@v1
+      # - uses: codecov/codecov-action@v4
+      #   with:
+      #     file: lcov.info
+      #     token: ${{ secrets.CODECOV_TOKEN }}
+
+  docs:
+    name: Documentation
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: julia-actions/setup-julia@v2
+        with:
+          version: '1'
+      - run: |
+          git config --global user.name name
+          git config --global user.email email
+          git config --global github.user username
+      - run: |
+          julia --project=docs -e '
+            using Pkg
+            Pkg.develop(PackageSpec(path=pwd()))
+            Pkg.instantiate()
+            Pkg.build()'
+      - run: |
+          julia --project=docs -e '
+            using Documenter: doctest
+            using PiGPIO
+            doctest(PiGPIO)'
+      - run: julia --project=docs docs/make.jl
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}

.github/workflows/TagBot.yml

@@ -1,11 +1,33 @@
 name: TagBot
 on:
-  schedule:
-    - cron: 10 20 * * *
+  issue_comment:
+    types:
+      - created
+  workflow_dispatch:
+    inputs:
+      lookback:
+        default: "3"
+permissions:
+  actions: read
+  checks: read
+  contents: write
+  deployments: read
+  issues: read
+  discussions: read
+  packages: read
+  pages: read
+  pull-requests: read
+  repository-projects: read
+  security-events: read
+  statuses: read
 jobs:
   TagBot:
+    if: github.event_name == 'workflow_dispatch' || github.actor == 'JuliaTagBot'
     runs-on: ubuntu-latest
     steps:
       - uses: JuliaRegistries/TagBot@v1
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
+          # Edit the following line to reflect the actual name of the GitHub Secret containing your private key
+          ssh: ${{ secrets.DOCUMENTER_KEY }}
+          # ssh: ${{ secrets.NAME_OF_MY_SSH_PRIVATE_KEY_SECRET }}

Project.toml

@@ -1,9 +1,19 @@
-name = "PiGPIO"
-uuid = "bb151fc1-c6dc-5496-8ed6-07f94907e623"
-version = "0.2.0"
-
-[compat]
-julia = "1"
-
-[deps]
-Sockets = "6462fe0b-24de-5631-8697-dd941f90decc"
+name = "PiGPIO"
+uuid = "bb151fc1-c6dc-5496-8ed6-07f94907e623"
+version = "0.2.1"
+
+[compat]
+Aqua = "0.8"
+Sockets = "1"
+Test = "1"
+julia = "1"
+
+[deps]
+Sockets = "6462fe0b-24de-5631-8697-dd941f90decc"
+
+[extras]
+Aqua = "4c88cf16-eb10-579e-8560-4a9242c79595"
+Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
+
+[targets]
+test = ["Aqua", "Test"]

README.md

@@ -3,6 +3,7 @@
 #### Control GPIO pins on the Raspberry Pi from Julia
 
 [![][docs-stable-img]][docs-stable-url]
+[![documentation dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://juliaberry.github.io/PiGPIO.jl/dev/)
 
 [docs-stable-img]: https://img.shields.io/badge/docs-stable-blue.svg
 [docs-stable-url]: https://juliahub.com/docs/PiGPIO/
@@ -35,10 +36,18 @@ work is done by the daemon. One benefit of working this way is that you can
 remotely access the pi over a network and multiple instances can be connected
 to the daemon simultaneously.
 
-## Launching the Daemon
+## The daemon process `pigpiod`
 
-Launching the daemon requires sudo privileges. Launch by typing `sudo pigpiod`
-in the terminal.
+On Raspberry Pi OS, the daemon `pigpiod` can be installed and launched by using the following shell commands:
+
+```bash
+# install pigpiod
+sudo apt-get install pigpiod
+# enable pigpiod via system D
+sudo systemctl enable pigpiod
+```
+
+The daemon can also be launched manually with `sudo pigpiod` in the terminal.
 
 ## Installation and Usage
 
@@ -48,20 +57,24 @@ Pkg.add("PiGPIO")
 
 using PiGPIO
 
-pi=Pi() #connect to pigpiod daemon on localhost
+pi=Pi() # connect to the pigpiod daemon on localhost
 ```
 
 ## Example Usage
 
+The `pin` number corresponds to the GPIO pins
+(General Purpose Input/Output, aka "BCM" or "Broadcom") and not 
+to the physical pin numbers.
+
 ```julia
-set_mode(p::Pi, pin::Int, mode)
-get_mode(p::Pi, pin::Int)
-# mode can be INPUT or OUTPUT
+set_mode(pi::Pi, pin::Int, mode)
+get_mode(pi::Pi, pin::Int)
+# mode can be PiGPIO.INPUT or PiGPIO.OUTPUT
 
-PiGPIO.read(p, pin)
-PiGPIO.write(p, pin, state)
-#state can be HIGH, LOW, ON, OFF
+PiGPIO.read(pi, pin)
+PiGPIO.write(pi, pin, state)
+# state can be PiGPIO.HIGH, PiGPIO.LOW, PiGPIO.ON, PiGPIO.OFF
 
-PiGPIO.set_PWM_dutycycle(p, pin, dutycyle)
-#dutycyle defaults to a range 0-255
+PiGPIO.set_PWM_dutycycle(pi, pin, dutycyle)
+# dutycyle defaults to a range 0-255
 ```

docs/make.jl

@@ -10,9 +10,12 @@ makedocs(
     sitename = "PiGPIO",
     format = Documenter.HTML(),
     modules = [PiGPIO],
+    # examples need to be run on a Raspberry Pi
+    doctest = false,
+    draft = true,
     pages = [
         "index.md",
-        "Tutorial" => "tutorial.md"
+        "Tutorial" => "tutorial.md",
         "API Docs" => "api.md",
         "Examples" => [
             "Blink Once" => "examples/01_blink.md",
@@ -22,9 +25,6 @@ makedocs(
     ]
 )
 
-# Documenter can also automatically deploy documentation to gh-pages.
-# See "Hosting Documentation" and deploydocs() in the Documenter manual
-# for more information.
-#=deploydocs(
-    repo = "<repository url>"
-)=#
+deploydocs(;
+    repo="github.com/JuliaBerry/PiGPIO.jl",
+)

src/PiGPIO.jl

@@ -3,6 +3,7 @@ module PiGPIO
 
 export Pi
 
+import Base: run
 using Sockets
 
 include("constants.jl")