OccamDoc index

Modules

Module base - Very basic, nothing-specific code that is called at every level of code
Module digital - Processes for manipulating digital pins
Module plumbing - The Plumbing library
Module printing - Printing support for Plumbing
Module pwm
Module servo - Servo wrapper functions
Module twi - occam implementation of TWI for the AVR
Module wiring - Occam bindings written to resemble the C-like wiring API

Declarations

Function BV - Convert a bit number to a bit value
Constant INPUT - Symbolic constant for setting data direction registers to input
Data type LEVEL - Symbolic constant for setting the level of a digital pin
Constant OUTPUT - Symbolic constant for setting data direction registers to output
Protocol SERVO - Servo control protocol
- Tag div - Number of divisions in the span between max - min
- Tag frequency - Frequency of the servo pulse
- Tag max - Maximum time active; in microseconds
- Tag min - Minimum time active; in microseconds
- Tag pos - Positition of the servo; This is what you will be using the most
- Tag start - Starts servo operations
- Tag stop - Supposed to stop servo operations
- Tag usec - Number of microseconds (greater than min ) the pulse to the servo will last
Process adc - Reads the analog value of a given pin
Process blink - Drives a pin alternately LOW and HIGH on a fixed cycle
Process button.press - Watches for button presses on external level interrupt pins
Process clamp.byte - Limits the range of values in a stream
Process clamp.int - Limits the range of values in a stream
Process crawl.byte - Crawls a BYTE from 0 to high and back down (and back up, etc.)
Process crawl.int - Crawls an INT from 0 to high and back down (and back up, etc.)
Process debounce - Debounce a channel
Process delay - Wait for a period of time
Process die - Kills everything and reports an error back to the user
Process digital.input - Read digital levels on external level interrupt pins
Process digital.mode - Sets the Data Direction Register of the given pin (sets the flow of data) to either INPUT or OUTPUT
Process digital.output - Set digital levels on a pin
Process digital.read - Reads the digital state of a pin
Process digital.write - Sets the digital state of a pin to either HIGH or LOW
Process heartbeat - A parallel health monitor
Process invert.level - Invert LEVELs
Process level.to.signal - Convert a LEVEL to a SIGNAL
Process pin.toggle - Drives a pin alternately LOW and HIGH
Process potentiometer.byte - Reads from a potentiometer and maps the incoming value to a BYTE
Process printing.real32toa.helper - Real 32 to array helper function
Process printing.trimTrailing0s - Helps the user trim the trailing 0s from an array of BYTEs by decrementing total by one for every consecutive '0' at the end of the BYTE array
Process printing.zeroArray - Fills the passed array with the character '0'
Process pwm - Writes an analog value to a pin
Process pwm16 - Writes an analog value to a pin
Process real32toa - Converts n into a printable array
Process serial.read.byte - Reads a BYTE from the given pin
Process serial.setup - Begins serial operations on the given board pin
Process serial.write.byte - Write a BYTE to the given pin
Process serial.write.int - Write an INT to the serial port in hex
Process serial.write.int32 - Write an INT32 to the serial port in hex
Process serial.write.newline - Write a newline
Process serial.write.real32 - Write a REAL32 to the serial port in decimal form
Process serial.write.string - Write a string to the serial port
Process servo - General servo control
Process simple.servo - Stepping-stone servo control process
Process tick - Generates a consistent stream of SIGNALs
Process toggle - Outputs an alternating stream of LEVEL values