RUBY API

AREA512 provides the APIs on this page as built-ins. They can be used without require.

Reference Implementation

The preinstalled Widget Gallery application shows PicoRuby implementations using Display, Sprite, Widget, WidgetList, and WidgetTextView.

Display

Controls the device display.

• Display.width
• Display.height
• Display.fill_screen(color)
• Display.brightness = brightness
• Display.console

Sprite

Creates an off-screen drawing surface that can be pushed to the display.

• Sprite.new(width, height, font_size = nil)
• width, height, delete
• fill(color), pixel(x, y, color)
• line(x0, y0, x1, y1, color)
• rect(x, y, width, height, color)
• fill_rect(x, y, width, height, color)
• circle(x, y, radius, color)
• fill_circle(x, y, radius, color)
• text(x, y, string, color)
• push(x, y, transparent_color = nil)

BandedSprite

Draws the screen one band of rows at a time. draw transfers the previous region and prepares the next one, and returns false after the final transfer.

• BandedSprite.new(font_size)
• width, height, delete
• fill(color), pixel(x, y, color)
• line(x0, y0, x1, y1, color)
• rect(x, y, width, height, color)
• fill_rect(x, y, width, height, color)
• circle(x, y, radius, color)
• fill_circle(x, y, radius, color)
• text(x, y, string, color)
• draw, region_top, region_bottom

Dot

Loads and edits .a5d dot images.

• Dot.load(path), Dot.edit(path)
• width, height
• painted_left, painted_top, painted_right, painted_bottom
• push(sprite, x, y)
• Dot.overlap?(first, first_x, first_y, second, second_x, second_y, use_hitbox = false)

Widget

Draws AREA512 user-interface components on a Sprite and reads keys.

• Colors and layout: bg, amber, dim, gold, dark, char_width, row_height, header_height, body_top, body_bottom, body_height
• Text and input: text_width, clip, read_key, text_center, text_right, center_lines, wrap_text, marquee, big_text
• Layout: header, footer, hints, separator, vseparator, tabs, battery, splash, panel, titled_panel, toast
• Data display: cell, table_header, table_row, field, gauge, slider, scrollbar, hscrollbar, badge, busy, page_dots, bar_chart, line_chart
• Controls: button, checkbox, radio, toggle, spinner, input, input_number, confirm, dialog, menu, alert

WidgetList

Manages and draws a selectable, scrollable list.

• WidgetList.new
• area, clear, add
• empty_text=, show_marks=, toggle_mark, mark, marked?
• count, index, index=, top, handle, draw

WidgetTextView

Manages and draws scrollable text.

• WidgetTextView.new
• area, text=, scroll, scroll=, handle, draw

GPIO

Reads and writes GPIO pins and configures their direction, pull mode, open-drain mode, and alternate function.

• GPIO.new(pin, flags, alt_function = nil)
• read, write, high?, low?
• setmode, set_function, set_dir, set_pull, open_drain
• GPIO.read_at, GPIO.write_at, GPIO.high_at?, GPIO.low_at?
• GPIO.set_function_at, GPIO.set_dir_at, GPIO.pull_up_at, GPIO.pull_down_at, GPIO.open_drain_at

I2C

Communicates with I2C devices.

• I2C.new(unit:, frequency:, sda_pin:, scl_pin:, timeout:)
• write, read, scan

SD, File, and Dir

Mounts the microSD card and accesses its files and directories.

• SD.mount, SD.unmount, SD.exist?, SD.read, SD.write
• File.new, File.open, read, close
• File.exist?, File.file?, File.directory?, File.unlink, File.rename
• Dir.open, read, close
• Dir.exist?, Dir.mkdir, Dir.rmdir

IO

Reads keys and controls the console input mode.

• IO.open, IO.get_cursor_position, IO.wait_terminal, IO.clear_screen
• getch, read_nonblock
• raw, raw!, cooked, cooked!, echo?, echo=

RNG

Provides random values.

• RNG.random_int
• RNG.random_string(length)
• RNG.uuid

Sandbox

Compiles and executes Ruby source or .mrb bytecode in a sandbox task.

• Sandbox.new
• compile, compile_from_memory, execute
• exec_mrb, exec_mrb_from_memory, load_file, load_manifest
• wait, state, result, error
• resume, suspend, stop, terminate
• free_parser, cleanup