Skip to content
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
src
 
 
 
 
 
 
 
 
 
 
 
 

qxsl: Amateur-Radio Logging Library & LISP

image image image image

qxsl is a Java library for processing amateur-radio log files, including scoring and tabulation frameworks for ham radio contests.

Features

  • provides log en/decoders for QXML, ADIF, Cabrillo, zLog, CTESTWIN, etc.
  • provides tabulation & scoring frameworks for amateur-radio contests and awards.
  • provides the rulekit framework which allows you to write contest rules in JS, Ruby, Python, and LISP.

Documents

Applications

Sample Codes

Because we are Scalalians, please be patient to read Scala codes!

Document Model

The package qxsl.model defines the structure of log files, where each communication is handled as an Item object, while the entire log is represented as List[Item]. Each Item contains some Field objects, which indicate properties such as Time, Mode and Band. In addition, each Item holds two Node objects, namely Rcvd and Sent, which involve some messages (Fields) exchanged by the operator and the contacted station.

import qxsl.model.{Item,Rcvd,Sent}
val item: Item = new Item
val rcvd: Rcvd = item.getRcvd
val sent: Sent = item.getSent

Field Management

The package qxsl.field provides a management framework for Field implementations. The class FieldManager detects FieldFactory implementations from the class path automatically, and each FieldFactory provides en/decoders for individual Field implementation.

val fields = new qxsl.field.FieldManager()
item.set(fields.cache(new QName("qxsl.org", "mode")).field("CW"))
item.set(fields.cache(new QName("adif.org", "MODE")).field("CW"))
val mode = item.value(new QName("qxsl.org", "mode"))

This mechanism is utilized for en/decoding the QXML format, which is an alternative log format proposed by the qxsl development team. QXML is extensible, and supports namespaces which have been prohibited in the traditional ADIF:

<?xml version="1.0" encoding="UTF-8"?>
<list xmlns:qxsl="qxsl.org">
  <item qxsl:time="2017-06-03T16:17:00Z" qxsl:call="QV1DOK" qxsl:band="14000" qxsl:mode="CW">
    <rcvd qxsl:rstq="599" qxsl:code="120103"/>
    <sent qxsl:rstq="599" qxsl:code="100110"/>
  </item>
  <item qxsl:time="2017-06-04T00:01:00Z" qxsl:call="QD1QXB" qxsl:band="21000" qxsl:mode="CW">
    <rcvd qxsl:rstq="599" qxsl:code="110117"/>
    <sent qxsl:rstq="599" qxsl:code="100110"/>
  </item>
</list>

Decoding & Encoding

The package qxsl.table provides a basic framework for en/decoding log files including QXML and ADIF. The class TableManager detects individual formats (TableFactorys) from the class path automatically, and also provides the detect method for automatic format detection.

val tables = new qxsl.table.TableManager()
val table: List[Item] = tables.decode(Files.readAllBytes(path))
tables.getFactory("qxml").encoder(Files.newOutputStream(path)).encode(table)

The package qxsl.sheet provides an en/decoding framework similar to the qxsl.table package, except that qxsl.sheet handles contest summary sheets such as Cabrillo and JARL summary sheet R2.0. The class SheetManager manages individual SheetFactory implementations, and also provides the unpack method useful for extracting table items from a summary sheet.

val sheets = new qxsl.sheet.SheetManager()
val table: List[Item] = tables.decode(sheets.unpack(Files.readAllBytes(path)))

Scoring for Awards & Contests

The package qxsl.ruler provides a rulemaking framework for amateur radio awards and contests. Each contest is represented as a Contest object, which is provided by a RuleKit object or a script engine to define the contest.

import qxsl.ruler.{Contest,RuleKit}
val engine = RuleKit.forName("elva")
val stream = engine.getClass().getResourceAsStream("allja1.lisp")
val allja1 = engine.contest(new InputStreamReader(stream, UTF_8))

Each contest involves multiple Section objects. The Section object accepts List[Item] and validates the communications one by one, by invoking the summarize method.

import qxsl.ruler.{Section,Summary}
for(section: Section <- allja1.getSections().asScala) {
  val summary: Summary = section.summarize(table)
  println(section.getCode())
  println(section.getName())
  summary.accepted.asScala.foreach(println)
  summary.rejected.asScala.foreach(println)
  println(summary.score())
  println(summary.total())
}

Currently, the RuleKit class supports some domain specific languages, including JS, Ruby, Python, and Elva. Elva is a special LISP for the purpose of contest definition.

Bundled Contest Definitions

The following LISP programs are bundled inside the JAR file, as sample codes in Elva.

Supported Formats

TableFactory

name format ext
qxml QXML
jarl JARL
adis ADIF .adi
adxs ADIF .adx
cqww CQWW .cbr
zbin zLog .zlo
zdos zLog .txt
zall zLog .all
cbin CTESTWIN .lg8
ctxt CTESTWIN .txt

SheetFactory

name format
jarl JARL R2.0
cab3 Cabrillo3

Maven

If you want to use the latest build, configure the build.gradle as follows:

repositories.maven {
  url('https://nextzlog.github.io/qxsl/mvn/')
}

dependencies {
  implementation('qxsl:qxsl:+')
}

Build

Gradle retrieves dependent libraries, runs tests, and generates a JAR file automatically.

$ gradle build javadoc publish

You can create a native command line application instead of a JAR file. GraalVM must be installed before compilation. Then run the commands manually as follows:

$ native-image -cp build/libs/qxsl.jar
$ qxsl.exe format foo.adi bar.adx adxs

Contribution

Feel free to contact @nextzlog on Twitter.

License

Author

無線部開発班

Clauses

  • This library is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

  • This library is distributed in the hope that it will be useful, but without any warranty; without even the implied warranty of merchantability or fitness for a particular purpose. See the GNU Lesser General Public License for more details.

  • You should have received a copy of the GNU Lesser General Public License along with this library. If not, see http://www.gnu.org/licenses/.

About

amateur-radio logging library for Java, including an ADIF decoder and LISP-based scoring framework for contests.

Topics

Resources

License

Packages

No packages published