norns

• Index

Contents

• Functions
• Fields

Modules

• arc
• audio
• clock
• controlspec
• crow
• core.crow.public
• core.crow.quote
• encoders
• engine
• gamepad
• grid
• hid
• keyboard
• metro
• midi
• norns
• osc
• params.binary
• params.control
• params.file
• params.group
• params.number
• params.option
• params.separator
• params.taper
• params.text
• params.trigger
• paramset
• poll
• screen
• script
• softcut
• lib.beatclock
• lib.container.defaulttable
• lib.container.deque
• lib.container.observable
• lib.container.watchtable
• lib.container.weaktable
• lib.elca
• lib.envgraph
• lib.er
• lib.fileselect
• lib.filtergraph
• lib.filters
• lib.formatters
• lib.graph
• lib.intonation
• lib.lattice
• lib.lfo
• lib.listselect
• lib.musicutil
• lib.pattern_time
• lib.reflection
• lib.sequins
• lib.tabutil
• lib.test.luaunit
• lib.textentry
• lib.textentry_kbd
• lib.timeline
• lib.ui
• lib.util
• lib.voice

Module clock

clock coroutines

The norns script reference has examples for this module.

Functions

run (f[, ...])	create and start a coroutine using the norns clock scheduler.
cancel (coro_id)	stop execution of a coroutine previously started using clock.run.
sleep (s)	suspend execution of the calling coroutine and schedule resuming in specified time.
sync (beat[, offset])	suspend execution of the calling coroutine and schedule resuming at the next sync quantum of the specified value.
set_source (source)	select the sync source.
get_beats ()	get current time in beats.
get_tempo ()	get current tempo.
get_beat_sec ()	get length of a single beat at current tempo in seconds.

Fields

clock.transport.start	static callback when clock transport is started; user scripts can redefine
clock.transport.stop	static callback when clock transport is stopped; user scripts can redefine
tempo_change_handler	static callback when clock tempo is adjusted via PARAMETERS > CLOCK > tempo; user scripts can redefine

Functions

run (f[, ...])

create and start a coroutine using the norns clock scheduler.

Parameters:

• f function coroutine body function
• ... any extra arguments will be passed to the body function (optional)

Returns:

integer coroutine handle that can be used with clock.cancel

See also:

clock.cancel

cancel (coro_id)

stop execution of a coroutine previously started using clock.run.

Parameters:

• coro_id integer coroutine handle

See also:

clock.run

sleep (s)

suspend execution of the calling coroutine and schedule resuming in specified time. must be called from a coroutine previously started using clock.run.

Parameters:

• s float seconds to wait for

sync (beat[, offset])

suspend execution of the calling coroutine and schedule resuming at the next sync quantum of the specified value. must be called from a coroutine previously started using clock.run.

Parameters:

• beat float sync quantum. may be larger than 1
• offset float if set, this value will be added to the sync quantum (optional)

set_source (source)

select the sync source.

Parameters:

• source string "internal", "midi", or "link"

get_beats ()

get current time in beats.

get_tempo ()

get current tempo.

get_beat_sec ()

get length of a single beat at current tempo in seconds.

Fields

clock.transport.start

static callback when clock transport is started; user scripts can redefine

clock.transport.stop

static callback when clock transport is stopped; user scripts can redefine

tempo_change_handler

static callback when clock tempo is adjusted via PARAMETERS > CLOCK > tempo; user scripts can redefine

• bpm : the new tempo