Swiftpack.co - Package - peterhagelund/VC0706

VC0706

Library for controlling a VC07xx camera such as the Adafruit TTL Serial JPEG Camera.

Copyright and License

Copyright (c) 2019 Peter Hagelund

This software is licensed under the MIT License

See LICENSE.txt

Please note: This library is largely a Swift version of Limor Fried/Ladyada's Arduino library.

Installation and Setup

  • Clone the repository (git clone https://github.com/peterhagelund/VC0706.git)
  • cd VC0706/
  • swift build
  • swift package generate-xcodeproj
  • open VC0706.xcodeproj/

Documentation

The source contains documentation comments suitable for jazzy

TL;DR:

  • [sudo] gem install jazzy
  • jazzy --clean --author "Peter Hagelund" --module VC0706 --min-acl private
  • open docs/index.html

Testing

All testing of this library has been done manually by writing code that exercises the various library methods.

Please note: I currently only have access to the above mentioned TTL camera from Adafruit, so that's the only one I've tested with.

Using

For projects that depend upon VC0706, make sure Package.swift contains the correct dependency:

// swift-tools-version:5.0
// The swift-tools-version declares the minimum version of Swift required to build this package.

import PackageDescription

let package = Package(
    name: "<package name>",
    products: [
        .library(
            name: "<package name>",
            targets: ["<your target>"]),
    ],
    dependencies: [
        .package(url: "https://github.com/peterhagelund/VC0706.git", from: "1.0.0")
        .package(url: "https://github.com/...", from: "...")
        .package(url: "https://github.com/...", from: "...")
    ],
    targets: [
        .target(
            name: "<your target>",
            dependencies: ["VC0706", "...", "..."]),
        .testTarget(
            name: "<your test target>",
            dependencies: ["<your target>"]),
    ]
)

Error Handling

The Camera communicates with a real-world, physical camera, so anything can wrong at any time.

All public functions declare throws and in case of an error a POSIXError instance is thrown.

Github

link
Stars: 0
Help us keep the lights on

Dependencies

Used By

Total: 0