ModSwift

---

Summary

Library to easy generate Modbus commands in Swift.

Installation

Swift Package Manager

Once you have your Swift package set up, adding ModSwift as a dependency is as easy as adding it to the dependencies value of your Package.swift.

dependencies: [
    .package(url: "https://github.com/ivanesik/ModSwift.git", from: "0.0.3")
]

CocoaPods

To integrate CrcSwift into your Xcode project using CocoaPods, specify it in your Podfile:

pod 'ModSwift', '~> 0.0.3'

Usage

Master Mode

Setup

var modbus = ModSwift()             // Default .tcp, slave address = 0x00
modbus.setSlave(slaveAdress: 10)    // Set modbus slave address to 0x0A
modbus.setMode(.rtu)                // Set package generate to ModbusRTU mode
modbus.setTransactionId(15)         // Set modbus transaction id to 0x000E (just in .tcp mode)
modbus.setProtocolId(3)             // Set modbus protocol id to 0x0003 (just in .tcp mode)

Package create

var modbus = ModSwift()
let dataRCS = modbus.readCoilStatus(startAddress: 0x010D, numOfCoils: 0x0019)
print(dataRCS as NSData) //<00010000 00060B01 010D0019>

let dataPMR = modbus.presetMultipleRegisters(startAddress: 0x010D, values: [0xA30D, 0x1501, 0x1127])
print(dataPMR as NSData) //<00010000 000d0b10 010d0003 06a30d15 011127>

Auto Increment Mode

var modbus = ModSwift(mode: .tcp)
modbus.setTransctionAutoIncrement(true)

print(modbus.forceSingleCoil(startAddress: 0x0000, value: true))
// 0x00000000000600050000ff00
print(modbus.forceSingleCoil(startAddress: 0x0000, value: true))
// 0x00010000000600050000ff00

Features

Type:

• Modbus Client (Master)
• (in progress) Modbus Server (Slave)

Mode:

• TCP
• RTU
• ASCII

Functions:

Function Name	Function Code	Function Number
Read coil (one bit) register	ModSwift.readCoilStatus	0x01
Read discrete (one bit) register	ModSwift.readDiscreteInputs	0x02
Read holding (16 bit) register	ModSwift.readHoldingRegisters	0x03
Read input (16 bit) register	ModSwift.readInputRegisters	0x04
Write coil (one bit) register	ModSwift.forceSingleCoil	0x05
Write holding (16 bit bit) register	ModSwift.presetSingleRegister	0x06
Read Exception Status	ModSwift.readExceptionStatus	0x07
Diagnostic	ModSwift.diagnostic	0x08
Get Comm Event Counter	ModSwift.getCommEventCounter	0x0B
Get Comm Event Log	ModSwift.getCommEventLog	0x0C
Write multiply coil (one bit) registers	ModSwift.forceMultipleCoils	0x0F
Write multiply holding (16 bit bit) registers	ModSwift.presetMultipleRegisters	0x10
Report Server ID	ModSwift.reportServerId	0x11
Read File Record	ModSwift.readFileRecord	0x14
Write File Record	ModSwift.writeFileRecord	0x15
Mask Write Register	ModSwift.maskWriteRegister	0x16
Read and Write Multiple registers	ModSwift.readAndWriteMultipleRegisters	0x17
Read FIFO Queue	ModSwift.readFIFOQueue	0x18
Encapsulated Interface Transport	ModSwift.encapsulatedInterfaceTransport	0x2B

TODO

• Doc: examples for every function
• Refactor: remove createCommand overloads (only command: ..., data: ...) and make structs for commands
• Feature: Presets for diagnostic (0x08) function
• Modes:
  • Modbus Plus
  • Pemex Modbus
  • Enron Modbus
• Feature: Slave mode
• Feature: Error Codes
• Feature: Different CRC modes
• Feature: corner cases from doc (max pdu size and others)
• CI: Tests
• CI: Pod lint
• CI: Check Code format
• Think: Split TCP and RTU into 2 classes with extension of base class BaseModbus

License

MIT licensed.