The workout-timer Reference Manual

Next: , Previous: , Up: (dir)   [Contents][Index]

The workout-timer Reference Manual

This is the workout-timer Reference Manual, version 1.0.6, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Aug 15 06:12:09 2022 GMT+0.

Table of Contents


1 Introduction

workout-timer

workout-timer is a trivial workout timer written in Common Lisp. Its behavior can be configured with various invocation flags, but its default mode is to offer a 7-minute workout. Being written in Common Lisp, it is pretty easy to modify for anyone who knows how to program in Lisp.

workout-timer has only been tested on Linux (using SBCL, but any other implementation should do). All its dependencies are in Quicklisp. Its main dependency is mixalot which itself depends on various C libraries that may or may not configuration tweaks to work on other operating systems. Its invocation script relies on cl-launch.

On Ubuntu, I notably had to:

apt-get install sbcl cl-launch libvorbis-dev

Invocation

From a Unix shell command-line, you can invoke it with:

./workout-timer

Get its version with:

./workout-timer -V

Usage with:

./workout-timer -h

Implicit default behavior:

./workout-timer -v 1.0 -w 30 -p 10 \
  -e "Jumping jack" -e "Wall sit" -e "Push-up" -e "Abdominal crunch" \
  -e "Step-up onto chair" -e "Squat" -e "Triceps dip on chair" -e "Plank" \
  -e "High knees running in place" -e "Lunge" -e "Push-up and rotation" -e "Side plank"

Or, from the SBCL (SLIME) REPL:

(load "~/quicklisp/setup.lisp")
(ql:quickload "workout-timer")
(workout-timer:mix-it :volume 1.0 :work-seconds 30 :pause-seconds 10)

2 Systems

The main system appears first, followed by any subsystem dependency.


Next: , Previous: , Up: Systems   [Contents][Index]

2.1 workout-timer

Workout timer

Author

Francois-Rene Rideau

Home Page

http://cliki.net/workout-timer

Source Control

(GIT https://gitlab.common-lisp.net/frideau/workout-timer.git)

License

MIT

Long Description

Workout timer with clock ticks and gongs
programmed for a 7-minute workout but you can modify it to suit your own workout

Version

1.0.6

Dependencies
Source

workout-timer.asd.


Previous: , Up: Systems   [Contents][Index]

2.2 workout-timer/timer

Author

Francois-Rene Rideau

Home Page

http://cliki.net/workout-timer

Source Control

(GIT https://gitlab.common-lisp.net/frideau/workout-timer.git)

License

MIT

Dependencies
  • local-time (system).
  • mixalot (system).
  • mixalot-vorbis (system).
  • vorbisfile-ffi (system).
  • command-line-arguments (system).
Source

workout-timer.asd.


3 Files

Files are sorted by type and then listed depth-first from the systems components trees.


Previous: , Up: Files   [Contents][Index]

3.1 Lisp


3.1.1 workout-timer/workout-timer.asd

Source

workout-timer.asd.

Parent Component

workout-timer (system).

ASDF Systems

3.1.2 workout-timer/timer/file-type.lisp

Source

workout-timer.asd.

Parent Component

workout-timer/timer (system).

Packages

workout-timer/timer.

Public Interface
Internals

4 Packages

Packages are listed by definition order.


Previous: , Up: Packages   [Contents][Index]

4.1 workout-timer/timer

Source

file-type.lisp.

Nickname

workout-timer

Use List
  • command-line-arguments.
  • common-lisp.
  • local-time.
  • mixalot.
  • mixalot-vorbis.
  • uiop/driver.
  • vorbisfile.
Public Interface
Internals

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


Next: , Previous: , Up: Definitions   [Contents][Index]

5.1 Public Interface


5.1.1 Ordinary functions

Function: end-mixer ()
Package

workout-timer/timer.

Source

file-type.lisp.

Function: entry-point ()
Package

workout-timer/timer.

Source

file-type.lisp.

Function: main (args)
Package

workout-timer/timer.

Source

file-type.lisp.

Function: mix-it (&key work-seconds pause-seconds exercises volume)
Package

workout-timer/timer.

Source

file-type.lisp.

Function: start-mixer ()
Package

workout-timer/timer.

Source

file-type.lisp.


5.2 Internals


Next: , Previous: , Up: Internals   [Contents][Index]

5.2.1 Special variables

Special Variable: *bell*
Package

workout-timer/timer.

Source

file-type.lisp.

Special Variable: *buzzer*
Package

workout-timer/timer.

Source

file-type.lisp.

Special Variable: *click*
Package

workout-timer/timer.

Source

file-type.lisp.

Special Variable: *current-time*
Package

workout-timer/timer.

Source

file-type.lisp.

Special Variable: *gong*
Package

workout-timer/timer.

Source

file-type.lisp.

Special Variable: *mixer*
Package

workout-timer/timer.

Source

file-type.lisp.

Special Variable: *seven-minute-workout*
Package

workout-timer/timer.

Source

file-type.lisp.

Special Variable: *version*
Package

workout-timer/timer.

Source

file-type.lisp.

Special Variable: +workout-timer-option-spec+
Package

workout-timer/timer.

Source

file-type.lisp.


Previous: , Up: Internals   [Contents][Index]

5.2.2 Ordinary functions

Function: add-sample (sample)
Package

workout-timer/timer.

Source

file-type.lisp.

Function: bell ()
Package

workout-timer/timer.

Source

file-type.lisp.

Function: buzzer ()
Package

workout-timer/timer.

Source

file-type.lisp.

Function: click ()
Package

workout-timer/timer.

Source

file-type.lisp.

Function: countdown (n &key click)
Package

workout-timer/timer.

Source

file-type.lisp.

Function: get-samples (&optional volume)
Package

workout-timer/timer.

Source

file-type.lisp.

Function: get-vorbis-length-rate (x)
Package

workout-timer/timer.

Source

file-type.lisp.

Function: get-vorbis-sample (x &key mixer volume)
Package

workout-timer/timer.

Source

file-type.lisp.

Function: gong ()
Package

workout-timer/timer.

Source

file-type.lisp.

Function: integer-digits (n &optional base)

Given a non-negative integer N, return how many digits it takes to write n in given BASE

Package

workout-timer/timer.

Source

file-type.lisp.

Function: integer-length* (integer &optional base)
Package

workout-timer/timer.

Source

file-type.lisp.

Function: my-workout (&key work-seconds pause-seconds exercises silentp)
Package

workout-timer/timer.

Source

file-type.lisp.

Function: oggfile (x)
Package

workout-timer/timer.

Source

file-type.lisp.

Function: parse-double-float (string)

Parse STRING as a DOUBLE-FLOAT number.

Package

workout-timer/timer.

Source

file-type.lisp.

Function: pn (x &optional type)
Package

workout-timer/timer.

Source

file-type.lisp.

Function: show-help ()
Package

workout-timer/timer.

Source

file-type.lisp.

Function: show-picture ()
Package

workout-timer/timer.

Source

file-type.lisp.

Function: show-version ()
Package

workout-timer/timer.

Source

file-type.lisp.

Function: vsleep (&optional n)
Package

workout-timer/timer.

Source

file-type.lisp.

Function: workout-timer (&key work-seconds pause-seconds exercises volume help version)
Package

workout-timer/timer.

Source

file-type.lisp.


Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts


Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   A   B   C   E   F   G   I   M   O   P   S   V   W  
Index Entry  Section

A
add-sample: Private ordinary functions

B
bell: Private ordinary functions
buzzer: Private ordinary functions

C
click: Private ordinary functions
countdown: Private ordinary functions

E
end-mixer: Public ordinary functions
entry-point: Public ordinary functions

F
Function, add-sample: Private ordinary functions
Function, bell: Private ordinary functions
Function, buzzer: Private ordinary functions
Function, click: Private ordinary functions
Function, countdown: Private ordinary functions
Function, end-mixer: Public ordinary functions
Function, entry-point: Public ordinary functions
Function, get-samples: Private ordinary functions
Function, get-vorbis-length-rate: Private ordinary functions
Function, get-vorbis-sample: Private ordinary functions
Function, gong: Private ordinary functions
Function, integer-digits: Private ordinary functions
Function, integer-length*: Private ordinary functions
Function, main: Public ordinary functions
Function, mix-it: Public ordinary functions
Function, my-workout: Private ordinary functions
Function, oggfile: Private ordinary functions
Function, parse-double-float: Private ordinary functions
Function, pn: Private ordinary functions
Function, show-help: Private ordinary functions
Function, show-picture: Private ordinary functions
Function, show-version: Private ordinary functions
Function, start-mixer: Public ordinary functions
Function, vsleep: Private ordinary functions
Function, workout-timer: Private ordinary functions

G
get-samples: Private ordinary functions
get-vorbis-length-rate: Private ordinary functions
get-vorbis-sample: Private ordinary functions
gong: Private ordinary functions

I
integer-digits: Private ordinary functions
integer-length*: Private ordinary functions

M
main: Public ordinary functions
mix-it: Public ordinary functions
my-workout: Private ordinary functions

O
oggfile: Private ordinary functions

P
parse-double-float: Private ordinary functions
pn: Private ordinary functions

S
show-help: Private ordinary functions
show-picture: Private ordinary functions
show-version: Private ordinary functions
start-mixer: Public ordinary functions

V
vsleep: Private ordinary functions

W
workout-timer: Private ordinary functions

Jump to:   A   B   C   E   F   G   I   M   O   P   S   V   W