Functions

Scans for and retrieves a collection of available Zorb devices with a given hardware version (either V1 or V2) as enumerated in ZorbDevice.Version.

Usage Example:

// Retrieves a list all available devices as an array of `ZorbDevice` objects.
SwiftyZorb.retrieveAvailableDevices(withVersion: .V2) { result in
   switch result {
   case .success(let devices):
       // Retrieval succeeded
       for device in devices {
           // Do something with devices
       }
   case .failure(let error):
       // An error occurred during retrieval
   }
}

Maintaining backwares compatibility, scans for and retrieves a collection of available Zorb devices with V1 hardware.

Usage Example:

// Retrieves a list all available devices as an array of `ZorbDevice` objects.
SwiftyZorb.retrieveAvailableDevices(withVersion: .V2) { result in
    switch result {
    case .success(let devices):
       // Retrieval succeeded
       for device in devices {
           // Do something with devices
       }
    case .failure(let error):
       // An error occurred during retrieval
    }
}

Initiates a connection to an advertising Zorb device with a given hardware version (either V1 or V2) as enumerated inZorbDevice.Version.

Usage Example:

// Attempts connection to an advertising device
SwiftyZorb.connect(withVersion: .V2) { result in
   switch result {
   case .success:
       // Connect succeeded
   case .failure(let error):
       // An error occurred during connection
   }
}

Maintaining backwares compatibility, initiates a connection to an advertising Zorb device with V1 hardware.

Usage Example:

// Attempts connection to an advertising device
SwiftyZorb.connect { result in
   switch result {
   case .success:
       // Connect succeeded
   case .failure(let error):
       // An error occurred during connection
   }
}

Ends connection to a connected Zorb device.

Usage Example:

// After calling this method, device disconnection will be guaranteed
SwiftyZorb.disconnect()

Forgets previously stored device connection.

Usage Example:

// After calling this method, a new device connection can be created
SwiftyZorb.forget()

Writes the appropriate command to reset connected Zorb device’s Javascript virtual machine.

Usage Example:

SwiftyZorb.reset { result in
   switch result {
   case .success:
       // Reset succeeded
   case .failure(let error):
       // An error occurred during reset
   }
}

Reads version String from Zorb device.

Usage Example:

SwiftyZorb.readVersion { result in
    switch result {
    case .success(let version):
       // Reading version string succeeded
    case .failure(let error):
       // An error occurred during read
    }
}

Reads serial String from Zorb device.

Usage Example:

SwiftyZorb.readSerial { result in
    switch result {
    case .success(let serial):
       // Reading serial string succeeded
    case .failure(let error):
       // An error occurred during read
    }
}

Writes desired actuator data to Zorb device.

Usage Example:

SwiftyZorb.writeActuators(duration: 100, topLeft: 0, topRight: 0, bottomLeft: 25, bottomRight: 25) { result in
    switch result {
    case .success:
       // Write succeeded
    case .failure(let error):
       // An error occurred during write
    }
}

Writes a given string of Javascript to the connected Zorb device. Using this method requires internet connection, which is used to compile the Javascript to bytecode before transmission.

Usage Example:

let javascript = "new Zorb.Vibration(" +
    "0," +
    "new Zorb.Effect(0,100,11,250)," +
    "213" +
    ").start();"
SwiftyZorb.writeJavascript(javascript) { result in
   switch result {
   case .success:
       // Write succeeded
   case .failure(let error):
       // An error occurred during write
   }
}

Writes the Javascript code at a given URL to the connected Zorb device.

Usage Example:

let url = URL(string: "https://gist.githubusercontent.com/jakerockland/17cb9cbfda0e09fa8251fc7666e2c4dc/raw")!
SwiftyZorb.writeJavascript(at url) { result in
    switch result {
    case .success:
        // Write succeeded
    case .failure(let error):
        // An error occurred during write
    }
}

Writes a Zorb_Timeline object (as specified by zorb.pb.swift) to the UART RX characteristic.

Usage Example:

// Create Zorb_Timeline and Zorb_Vibration objects using the generated types provided by zorb.pb.swift.
var timeline = Zorb_Timeline()
var vibration = Zorb_Vibration()

// Populate data in the Zorb_Vibration object.
vibration.channels = 0x01
vibration.delay = 1000
vibration.duration = 2000
vibration.position = 0
vibration.start = 0
vibration.end = 100
vibration.easing = 2

// Append the Zorb_Vibration to the Zorb_Timeline.
timeline.vibrations.append(vibration)

// Write the bytecode to the UART RX characteristic.
SwiftyZorb.writeTimeline(timeline) { result in
   switch result {
   case .success:
       // Write succeeded
   case .failure(let error):
       // An error occurred during write
   }
}

Writes a given string of base64 encoded bytecode to the connected Zorb device.

Usage Example:

let bytecode = "BgAAAFAAAAAsAAAAAQAAAAQAAQABAAUAAAEDBAYAAQACAAYAOwABKQIDxEYBAAAABAABACEAAwABAgMDAAAGAAgAOwECt8gARgAAAAAAAAAFAAAAAAAAAAIAb24JAHRpbWVydGljawABAHQABgBNb21lbnQGAHVwdGltZQ=="
SwiftyZorb.writeBytecode(bytecode) { result in
   switch result {
   case .success:
       // Write succeeded
   case .failure(let error):
       // An error occurred during write
   }
}

Triggers a given pre-loaded pattern on the connected Zorb device.

Usage Example:

SwiftyZorb.triggerPattern(.🎊) { result in
    switch result {
    case .success:
       // Pattern triggered successfully
    case .failure(let error):
       // An error occurred in triggering pattern
    }
}