Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yageek/codekit
|||❚|❚|| Create 1D barcode for mobile native and WebAssembly using Rust :crab:
https://github.com/yageek/codekit
android barcode ffi ios mobile-multiplatform rust webassembly
Last synced: 29 days ago
JSON representation
|||❚|❚|| Create 1D barcode for mobile native and WebAssembly using Rust :crab:
- Host: GitHub
- URL: https://github.com/yageek/codekit
- Owner: yageek
- License: mit
- Created: 2022-10-14T20:23:50.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2024-01-05T14:05:24.000Z (12 months ago)
- Last Synced: 2024-10-14T20:59:22.141Z (2 months ago)
- Topics: android, barcode, ffi, ios, mobile-multiplatform, rust, webassembly
- Language: Rust
- Homepage:
- Size: 66.5 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: License.md
Awesome Lists containing this project
README
# CodeKit
A toolkit to generate 1D bar code. The generation logic is done on Rust and then wrapped into
different platforms/language using FFI or JNI.
You can generate the following types of codes:
- EAN8
- EAN13
- Code39
- Code93
- Codabar
The supported platform:
- iOS/macOS
- Android
## iOS/macOS
A xcframework and docc module are provided. See the releases page to download them.
## Install
Download the release asset from the release page or use SPM to add that dependencies to your SPM project:
```swift
.package(url: "https://github.com/yageek/codekit.git", from: "1.0.0")
```
### Register the filters
The first step is to register the filters into the system. On iOS, best ways would probably be
in the applications delegate.
In objective-c:
```objc
#import
/// Registering the filters
[[RCKCodeKit sharedInstance] registerFilters];
```
In swift:
```swift
import CodeKit
/// Registering the filters
RCKCodeKit.shared.registerFilters()
```
### Using a filter
For every filter, you can either use the safe API or the dynamic API.
### Safe API
See the different methods and protocol
- `RCKCodeGenerator`
- `RCKCodeKit/ean8GeneratorFilter`
- `RCKCodeKit/ean13GeneratorFilter`
- `RCKCodeKit/code39GeneratorFilter`
- `RCKCodeKit/code93GeneratorFilter`
- `RCKCodeKit/codabarGeneratorFilter`
- `RCKCodeKit/i2of5GeneratorFilter`
As an example, let's create a Code39 code:
```objc
CIFilter *filter = [RCKCodeKit code93GeneratorFilter];
filter.codeValue = @"TEST93";
CIImage *image = filter.outputImage;
```
```swift
let filter = RCKCodeKit.code93Generator()
filter.codeValue = "TEST93"
let image = filter.outputImage
```
### Dynamic API
The filters can be used using the standard CoreImage filter system.
The name of the different filters are:
- `RCKEAN8CodeGenerator`
- `RCKEAN13CodeGenerator`
- `RCKCode39CodeGenerator`
- `RCKICode93odeGenerator`
- `RCKI2of5CodeGenerator`
Each of this filter has the following properties as float elements to configure the shape
of the code:
- `borderWidth`: The border of the code. Defaults to 0.
- `quietSpace`: The quiet space of the code. Default to 7.
- `barCodeHeight`: The bar code height. Default to 50.
To setup the value of the code, use the string parameter `codeValue`.
As an example, let's create a Code39 code:
```objc
CIFilter *filter = [CIFilter filterWithName:@"RCKCode93CodeGenerator"];
[filter setValue:@"TEST93" forKey:@"codeValue"];
CIImage *image = filter.outputImage;
```
### Render to an UIImage
As we are using classic CoreImage filters, we can generate a `UIImage` using
the regular API:
```objc
CIFilter *filter = [RCKCodeKit code93GeneratorFilter];
filter.codeValue = @"TEST93";
CIImage *image = filter.outputImage;
CGFloat scaleX = CGRectGetWidth(self.imageView.frame)/CGRectGetWidth(image.extent);
CGAffineTransform tr = CGAffineTransformScale(CGAffineTransformIdentity, scaleX, scaleX);
CIImage *scaled = [image imageByApplyingTransform:tr];
UIImage *uiImage = [UIImage imageWithCIImage:scaled];
self.imageView.image = uiImage;
```
### Android
You can use gradle/mvn to retrieve the package from [Github Package](https://github.com/yageek/codekit/packages/)
A android AAR element is provided also in the release page.
The library contains functions to create a string of bars (0/1) from a java string
and one function to create a bitmap from those strings.
The available methods are the following:
```java
// Methods to generate a string of bars
public native static String makeEAN8(String code) throws IOException;
public native static String makeEAN13(String code) throws IOException;
public native static String makeCodabar(String code) throws IOException;
public native static String makeCode39(String code) throws IOException;
public native static String makeCode93(String code) throws IOException;
public native static String makeI2Of5(String code) throws IOException;
// Method to generate a bitmap from a string of bar
public static Bitmap convertBitmap(String descriptor, CodeOptions options)
```
A basic usage could be done as the following:
```java
import net.yageek.codekit.CodeKit;
import net.yageek.codekit.CodeOptions;
try {
// Creating the string of bars from the code
String test = CodeKit.makeCode93("TEST93");
// Creating a code with a height of 200, a quiet space of 7, no border and a bar width of 5
CodeOptions options = new CodeOptions(200, 7, 0, 5);
Bitmap bitmap = CodeKit.convertBitmap(test, options);
this.imageView.setImageBitmap(bitmap);
} catch (IOException e) {
e.printStackTrace();
}
```
### WebAssembly
Using the `wasm-bindgen` and `web-sys` crates, a webassembly version of the code generator is available.
You can retrieve the packages from [Github packages](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-npm-registry)
Main functions of the code are the followings:
```js
// Methods to create String representation of the code
codekit_create_ean8(code)
codekit_create_ean13(code)
codekit_create_codabar(code)
codekit_create_code39(code)
codekit_create_code93(code)
codekit_create_i2of5(code)
// Methods to draw the code in a canvas node
codekit_draw_ean8(canvasID, barWidth, codeHeight)
codekit_draw_ean13(canvasID, barWidth, codeHeight)
codekit_draw_codabar(canvasID, barWidth, codeHeight)
codekit_draw_code39(canvasID, barWidth, codeHeight)
codekit_draw_code93(canvasID, barWidth, codeHeight)
codekit_draw_i2of5(canvasID, barWidth, codeHeight)
```
Let's see a simple `index.html` file to use this:
```html
codekit-wasm example
import init, { codekit_create_ean8, codekit_draw_ean8 } from "./codekit.js";
init().then(() => {
try {
codekit_draw_ean8('drawing', '65833254', 2, 100);
} catch (e) {
alert("Invalid code " + e)
}
});
```