Skip to content

Latest commit

 

History

History
147 lines (102 loc) · 6.38 KB

README.md

File metadata and controls

147 lines (102 loc) · 6.38 KB
Raw

RSBarcodes, now Swift.

Carthage compatible Total views Views in the last 24 hours

RSBarcodes allows you to read 1D and 2D barcodes using the metadata scanning capabilities introduced with iOS 7 and generate the same set of barcode images for displaying and sharing. Now implemented in Swift.

##TODO

###Generators

  • Code39
  • Code39Mod43
  • ExtendedCode39
  • Code93
  • Code128
  • UPCE
  • EAN FAMILIY (EAN8 EAN13 ISBN13 ISSN13)
  • ITF14
  • Interleaved2of5
  • DataMatrix
  • PDF417
  • QR
  • Aztec
  • Views

###Reader

  • Views
  • ReaderController

##Installation

###CocoaPods

Simply add the following lines to your Podfile:

# required by Cocoapods 0.36.0.rc.1 for Swift Pods
use_frameworks! 

pod 'RSBarcodes_Swift', '~> 0.0.8'

(CocoaPods v0.36 or later required. See this blog post for details.)

###Carthage

Simply add the following line to your Cartfile:

github "yeahdongcn/RSBarcodes_Swift" >= 0.0.8

###Manual

  1. Add RSBarcodes_Swift as a submodule by opening the Terminal, cd-ing into your top-level project directory, and entering the command git submodule add https://github.com/yeahdongcn/RSBarcodes_Swift.git
  2. Open the RSBarcodes_Swift folder, and drag RSBarcodes.xcodeproj into the file navigator of your app project.
  3. In Xcode, navigate to the target configuration window by clicking on the blue project icon, and select the application target under the "Targets" heading in the sidebar.
  4. Ensure that the deployment target of RSBarcodes.framework matches that of the application target.
  5. In the tab bar at the top of that window, open the "Build Phases" panel.
  6. Expand the "Target Dependencies" group, and add RSBarcodes.framework.
  7. Click on the + button at the top left of the panel and select "New Copy Files Phase". Rename this new phase to "Copy Frameworks", set the "Destination" to "Frameworks", and add RSBarcodes.framework.

##Usage

HOW TO USE GENERATOR and HOW TO USE READER

###Generators

The simplest way to use the generators is:

RSUnifiedCodeGenerator.shared.generateCode("2166529V", machineReadableCodeObjectType: AVMetadataObjectTypeCode39Code)

It will generate an UIImage instance if the 2166529V is a valid code39 string. For AVMetadataObjectTypeCode128Code, you can change useBuiltInCode128Generator to false to use my implementation (AutoTable for code128).

P.S. There are 4 table for encoding a string to code128, TableA, TableB, TableC and TableAuto, the TableAuto is always the best choice, but if one has certain requirement, try this:

RSCode128Generator(codeTable: .A).generateCode("123456", machineReadableCodeObjectType: AVMetadataObjectTypeCode128Code)

These calling simples can be found in the test project.

###Reader

Place an UIViewController in storyboard and set RSCodeReaderViewController based class as its custom class and you're almost there. The focus mark layer and corners layer are already there working for you. There are two handlers: one for the single tap on the screen along with the focus mark and one detected objects handler, which all detected will come to you. Set them up in viewDidLoad() or some place more suitable:

override func viewDidLoad() {
    super.viewDidLoad()
    
    self.focusMarkLayer.strokeColor = UIColor.redColor().CGColor
    
    self.cornersLayer.strokeColor = UIColor.yellowColor().CGColor
    
    self.tapHandler = { point in
        println(point)
    }
    
    self.barcodesHandler = { barcodes in
        for barcode in barcodes {
            println("Barcode found: type=" + barcode.type + " value=" + barcode.stringValue)
        }
    }
}

If you want to ignore some code types, simply add following lines

let types = NSMutableArray(array: self.output.availableMetadataObjectTypes)
types.removeObject(AVMetadataObjectTypeQRCode)
self.output.metadataObjectTypes = NSArray(array: types)

###Helper

Use RSAbstractCodeGenerator.resizeImage(<#source: UIImage#>, scale: <#CGFloat#>) to scale the generated image.

##Miscellaneous

The Swift Programming Language 中文版

Online version generated using GitBook

##License

The MIT License (MIT)

Copyright (c) 2012-2014 P.D.Q.

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.