Bindings/Lua/apitest.lua

--[[
  libbrlapi - A library providing access to braille terminals for applications.
 
  Copyright (C) 2006-2023 by Dave Mielke <dave@mielke.cc>
 
  libbrlapi comes with ABSOLUTELY NO WARRANTY.
 
  This is free software, placed under the terms of the
  GNU Lesser General Public License, as published by the Free Software
  Foundation; either version 2.1 of the License, or (at your option) any
  later version. Please see the file LICENSE-LGPL for details.
 
  Web Page: http://brltty.app/
 
  This software is maintained by Dave Mielke <dave@mielke.cc>.
]]

local brlapi = require("brlapi")
require("../../brltty-prologue")

local function showProperty (name, value)
  io.stdout:write(string.format("%s: %s\n", name, tostring(value)))
end

local function performTests ()
  showProperty("BrlAPI Version", brlapi.version)
  if brlapi.version < {major=0, minor=8, revision=3} then
    error "BrlAPI is too old"
  end

  local brl <close> = brlapi.openConnection(arg[2], arg[3])

  showProperty("File Descriptor", brl:getFileDescriptor())
  showProperty("Driver Name", brl:getDriverName())
  showProperty("Driver Code", brl:getDriverCode())
  showProperty("Driver Version", brl:getDriverVersion())
  showProperty("Model Identifier", brl:getModelIdentifier())

  do
    local columns, rows = brl:getDisplaySize()
    showProperty("Display Size", string.format("%dx%d", columns, rows))
  end

  showProperty("Device Online", brl:getDeviceOnline())
  showProperty("Audible Alerts", brl:getAudibleAlerts())
  showProperty("Computer Braille Table", brl:getComputerBrailleTable())
  showProperty("Literary Braille Table", brl:getLiteraryBrailleTable())
  showProperty("Message Locale", brl:getMessageLocale())

  do
    local commandKeycodes = brl:getBoundCommandKeycodes();
    local string = ""
    for i = 1, #commandKeycodes, 1 do
      string = string .. brl:getCommandKeycodeName(commandKeycodes[i])
      if i < #commandKeycodes then
        string = string .. ", "
      end
    end
    showProperty("Bound Command Keycode Names", string)
  end

  do
    local driverKeycodes = brl:getDefinedDriverKeycodes();
    local string = ""
    for i = 1, #driverKeycodes, 1 do
      string = string .. brl:getDriverKeycodeName(driverKeycodes[i])
      if i < #driverKeycodes then string = string .. ", " end
    end
    showProperty("Defined Driver Keycode Names", string)
  end
end

do
  local ok, error = pcall(performTests)

  if not ok then
    writeProgramMessage(error)
    os.exit(9)
  end
end

os.exit()