API Reference bb_nsk v#0.1.2

Copy Markdown View Source

Modules

Board support for the Nerves Starter Kit and its Beam Bots Balance Bot add-on.

Keeps the robot upright, and knows when it has stopped being able to.

Arms the robot, and lands it in the state its attitude calls for.

Gives up balancing, leaving the robot waiting to be stood back up.

Shuts the robot down cleanly.

Hands the robot over to the balance controller.

The board's 4.2" e-paper panel: its size, its fonts and its packed formats.

Decides when the panel is redrawn, and with what.

The panel's main screen: network, robot and system status.

Takes packed frames off the renderer and puts them on the panel.

The panel, its renderer and the sink between them.

A screen exercising text and each of the basic shapes, for checking that the panel is wired up and that the rendering pipeline is the right way up.

The Emerge renderer behind the panel.

Where a pilot's intentions reach the balance controller.

Helpers the bb_nsk.add_* tasks share.

The four NeoPixels on the add-on board.

Shows the robot's safety state on the NeoPixels.

What a pilot is asking the robot to do.

The air around the robot.

Aliases a project needs when it draws on the panel.

The robot's own access point, and the credentials for joining somebody else's.

Decides whether the robot is an access point or a station, and notices when being a station hasn't worked.

The kernel's PWM channels, through sysfs.

Reads ambient temperature and humidity from the board's HTS221, and publishes them as BB.NSK.Message.EnvironmentState.

Reports which way the body is pointing, as the :ground joint's rotation.

Reports how far the body has fallen away from upright, as the :lean joint's configuration.

A snapshot of what the robot and the board it runs on are currently doing.

A mix nerves.new-shaped project for the installer tests to work on.

The Balance Bot's topology, with nothing attached to it.

Drives one wheel through a DRV8837 H-bridge.

Mix Tasks

Adds the balance loop, its states and its commands

Adds the 4.2" e-paper panel and the status screen it draws

Adds the base board's HTS221 temperature and humidity sensor

Adds the Balance Bot's IMU, its filter and the two derived sensors

Adds the NeoPixel state indicator

Adds the drive pad, the wifi setup page and the Phoenix they need

Adds the Balance Bot's two wheels to a robot

Makes the robot bring up its own network when it has none to join

Builds the whole Balance Bot in one go

Checks that the board is showing the hardware this package expects

Installs Balance Bot board support into a Nerves project

Removes NIFs built for another architecture before a firmware build

Puts the host's NIF back after a firmware build removed it