get_movie_status

Can be used to check whether the camera has stopped recording and has finished writing to the SD card.

If 0 or 1 is returned, movie recording is stopped or paused.

If 4 is returned, recording is in progress.

If 5 is returned, recording has stopped but camera is still writing movie to SD card.

Note : a return status of "6" has been reported from the sx150. It may mean that recording has stopped and writing to the SD card is complete.

set_movie_status

Is experimental and so far only works on A720 and S3IS cameras properly. Using this command video recording can be paused, unpaused and stopped.

set_movie_status 1 will pause recording (will not work on all cameras, typically they freeze or shutdown after 2 seconds!).

set_movie_status 2 will unpause (restart) recording.

set_movie_status 3 will stop video recording (this should work on all types of cameras).

get_video_button

Return 1 when camera has a video button.

Return 0 when camera has no video button.

The returned value is based on the whether the platform_camera.h file for the camea indicates that it has a video button.

get_display_mode

Returns LCD display mode (in record mode only), regardless of propset used by the camera (i.e. the function is universally available).

0 = show info icons, 1 = do not show info icons, 2 = LCD off, 3 = EVF

Note : this function is available in uBASIC only. For Lua use:

props=require("propcase")
display_mode=get_prop(props.DISPLAY_MODE)

get_propset

Returns the propset number used by the camera. Returns 1 for propset1, 2 for propset2, 3 for propset3 etc. Useful for writing scripts that are not dependent on a particular camera model or DIGIC processor. Information about values used for propsets can be found here: http://chdk.wikia.com/wiki/PropertyCase

get_zoom_steps

Returns number of maximum zoom steps, irrespective of the processor. For example on the A620 it will return 8, on the S3IS it will return 128.

This allows for universal zoom scripts.

Example:

for i=0 to get_zoom_steps
... do some things in this loop
next i

get_exp_count

will return number of shots in a session (afaik). useful for counting when you are for example in burst mode and want to stop after 3 shots.

get_histo_range

This command gets the information about the histogram of the last image that was shot (i.e. after you have focused, metered, shot etc.), it operates reading the RAW buffer (but doesn't require raw saving to be enabled: the shot histogram data is obtained from the RAW data before discarding or further processing it).

It can be very useful to get informations about very dark scenes: the live preview screen is completely black, while the RAW buffer (with a long enough exposure) would contain an image.

It depends on the shot_histo_enable command: if shot_histo_enable is not set, get_histo_range returns a value of -1, so shot_histo_enable has to be enabled first.

This is necessary because the shot-histogram is calculated just after each shot and takes some time. So, by default the shot-histogram is disabled and you need to enable it with shot_histo_enable.

rem enable shooting histogram
shot_histo_enable 1rem shoot
shoot
sleep 100rem let's read histogram of the shot that was just taken
h=get_histo_range 100800rem h contains the percentage of pixels that are between 100/1024 and 800/1024

changed RANDOM command

Example: "playsound random 3 6" will play the sounds 3,4,5,6 in random order (if repeated in a while loop)

playsound

Plays any of the built-in sound events, when sounds are turned on.

Example: "playsound 0"

Where 0 is the startup sound. There are sounds ranging from 0 to 7, 7 being a nasty long beep. The first few sounds can only be played if they are NOT muted by the camera, the other beeps will be played though (cam must be unmuted). This feature will lead to many more features, for example anti theft protection together with DataGhost's Disco lights.

0 = startup sound

1 = shutter sound

2 = button press sound

3 = selftimer

4 = short beep

5 = af (auto focus) confirmation

6 = error beep

7 = long beeeeeeeeeeeeeeeeeeep (nasty ! - can be stopped by half-pressing the shutter)

in uBASIC, calling print_screen with a positive number opens the log file in overwrite mode, ? and calling with a negative number opens an existing log file in append mode?

in Lua, calling print_screen() with a number greater than zero opens an existing log file in overwrite mode, and calling with a number less than zero opens an existing file in append mode. The file name number is abs(n).

Log files are stored in the folder \CHDK\LOGS with a naming scheme? LOG_XXXX.TXT

get_quality

Returns the current capturing quality setting in Canon grades, regardless of the cameras OS

For possible values see PropertyCase (basically quality can be 0-2 where 2 being the worst)

(not available in Lua yet)

get_resolution

(since changeset #497)

Returns the current capturing resolution setting in Canon grades, regardless of the cameras OS

For possible values see PropertyCase (basically resolution can be 0-8, corresponding to the Canon settings)

(not available in Lua yet)

set_quality

(since changeset #497)

Set the quality (in Canon grades), usually 0-2, see PropertyCase for possible values

(not available in Lua yet)

set_resolution

(since changeset #497)

Set the resolution (in Canon grades), usually 0-8, see PropertyCase for possible values

(not available in Lua yet)

get_platform_id

(since version 0.8.3 / changeset #593)

Returns platformid (integer), with the help of this you can code platform depending scripts (in Lua we dont need this, as we can get strings there). ?Platform-ID list

(only available in uBasic; for Lua scripts use get_buildinfo instead)

set_backlight()

With this function the LCD backlight (or EVF backlight) can be turned on and off - useful for energy saving or camouflage missions. (Backlight is a bright light inside the LCD, making the image visible.)

Usage:

set_backlight(x)(Lua)

set_backlight x (uBASIC)

where 0 disables backlight and 1 enables the backlight.

Notes :

The camera re-enables the backlight after each shot. To keep backlight mostly disabled, this command must be called after each shot. But do not call it immediately after a shot or its effect will be very shortlived. You must wait for LCD live view image exposure to settle before calling. The regular shoot state loop may help, possibly with some added delay. Test in varying lighting conditions to see if you got it right.

If you accidentally exit a script while the backlight is disabled, you can get it back by leaving ALT mode and shooting, or by powering off. The LCD can probably be somewhat read even when backlight is disabled if bright light is pointed at it from a suitable angle. Alternatively, you may turn on the LCD backlight in a section labeled :restore (uBasic) or a function called restore (Lua), which will be executed when the script is interrupted.

set_lcd_display()

With this function the LCD display and backlight (or EVF backlight) can be turned on and off - useful for energy saving or camouflage missions. (Backlight is a bright light inside the LCD, making the image visible.)

Usage:

set_lcd_display(x) (Lua)

set_lcd_display x(uBASIC)

where 0 disables the display and 1 enables the display.

Notes:

This command works much like set_backlight() except that it actually turns off the whole display and not just the backlight. The display also stays off after each shot - unlike the backlight when set_backlight() is used.

Restoring the display via set_lcd_display(1) may be somewhat slower than when restoring the backlight with set_backlight(1)

When set_lcd_display(1) is issued, the various Canon OSD icons and text may not be redrawn until the next press of a camera button while the camera is not in <ALT> mode.

If you accidentally exit a script while the display is disabled, you can get it back by leaving ALT mode (by pressing the <ALT> key once) and then repeatedly pressing the DISP key. You can also get it back by powering off. Alternatively, you may turn on the display in a section labeled :restore (uBasic) or a function called restore (Lua), which will be executed when the script is interrupted.

get_draw_title_line

This function returns the current on/off status of the CHDK OSD title line at the bottom of the LCD screen ( <ALT> and current script name ).

set_aflock

Lock/unlock autofocus

Usage:

Lua: set_aflock(x)

uBASIC:set_aflock x

where 1 locks the autofocus and 0 unlocks it.

It is like MF, but better in several ways, such as a) it is available on ALL cameras; b) focus is locked even after camera returns from deep display sleep (via display key cycle or print button shortcut), which is very good for timelapse, with regard to power consumption, camera shake, an actual fixed focus throughout the whole timelapse and also less stress on the mechanical parts of the camera.

Example:

press "shoot_half"
sleep 800
release "shoot_half"
set_aflock 1

set_aelock

(CHDK Version 1.3.0 or greater required)

Lock/unlock auto exposure adjust.

Usage:

Lua: set_aelock(x)

uBASIC:set_eflock x

where 1 locks autoexposure adjustments and 0 unlocks them.

set_record(state)

state 0 (or false) changes to play mode. 1 or true changes to record mode.

NOTE 1: this only begins the mode change. Script should wait until get_mode() reflects the change before doing anything that requires the new mode. e.g.

set_record(true)
while not get_mode() do
sleep(10)
end

NOTE 2: In ubasic, get_mode returns 0 for record, 1 for play and 2 for movie, so if you want save the state and restore it with set_record, you cannot just use the get_mode value directly. You can adjust the value from get_mode, or use get_capture_mode instead.

(since version 0.9.8 / changeset #826)

set_capture_mode_canon(value)

value is a valid PROPCASE_SHOOTING_MODE value for the current camera. If the value is negative, it is assumed to be a sign-extended short representation of the propcase value and is converted accordingly.

returns true (Lua only) if the camera is in rec mode.

NOTE: On some cameras, a short sleep (10ms) may be required before the mode change is complete.

(since version 0.9.9 / changeset #847)

set_capture_mode(modenum)

modenum is a valid mode in the CHDK modemap. The enumerated list of valid modes can be found in the source file modelist.h. The first five entries in that list are :

1 MODE_AUTO

2 MODE_P

3 MODE_TV

4 MODE_AV

5 MODE_M

e.g. : set_capture_mode 1 will set the camera into AUTO mode, set_capture_mode 3 will set the camera into Tv mode

returns true (lua only) if modenum is a valid modemap value and the camera is in rec mode, otherwise false

get_capture_mode

returns the current camera automatic image mode, or 0 if camera is in play mode or 0 if there is no modemap entry

(since version 0.9.9 / changeset #847)

set_console_layout

set_console_layout x1 y1 x2 y2 --> set console position and size, range is x=0 to 45 and y=0 to 14

Note : coordinates are in units of characters and are numbered from the lower left hand corner of the screen. So x1,y1 is the lower left corner and x2,y2 is the upper right corner.

set_console_autoredraw

set_console_autoredraw(-1|0|1) --> determines how text from a script's print() statement is handled when it is sent to the screen console buffer.

Parameters:

-1 = text from print statement is not added to console buffer

0 = text from print statement is added to console buffer but the console display is not refreshed.

1 = text from print statement is added to console buffer and the console display is refreshed.

Default setting = 1

Note : the print_screen() statement determines how text from a print statement is logged to the camera's SD card. It functions independently from the set_console_autoredraw() statement.

console_redraw

console_redraw() --> manually refresh/rewrite the script console

reboot([file])

Reboot the the camera, optionally using a specified file.

If file is not given, a normal the normal camera boot sequence is used, CHDK will be started or not based on the normal autostart rules.

If the first two characters of the file extension are "FI" the file will be treated loaded as a firmware update file, encoded with the normal firmware update encoding. Currently, this only works on DryOS, vxworks cameras will just return without rebooting.

In all other cases, the file must be an un-encoded binary, which is compiled to load at 0x1900.

On success, reboot does not return.

note reboot does not do a "nice" shutdown.

If the lens is extended, it will not be retracted before reboot.

Canon camera settings that are normally saved on shutdown are not saved. This includes the exposure counter.

If called from Lua, the Lua script script will not be terminated normally, so any open files etc will not be closed.

(since changeset #944 / FI* support in changeset 957)

restore

Both Lua and uBasic provide a mechanism for allowing the programmer to specify a piece of code to be executed immediately prior to the termination or interruption of a running program. This allows for such things as enabling the backlight if it was turned off or releasing overrides. To use this capability in uBasic, insert a label called :restore in your code (usually right before the end statement) and add the lines of code you would like executed as the program terminates or is interrupted.

To use this capability in Lua, add a function called restore() to your Lua script with the commands you would like to see executed when Lua terminates or interrupts the currently running script. In Lua, this function should be near to the top of your script, before any loops so it is defined when the script is interrupted.

Notes:

This code will be called when the script is terminated by pressing the camera's shutter button. However, in ubasic, the code will wait for any sleep commands to finish before executing so it might be better to use short sleep commands inside a counting loop rather than one long sleep command. In Lua, the function is executed immediately

Restore in lua should not using any functions that yield, such as sleep, key press / release etc.

set_exit_key

(CHDK Version 1.3.0 or greater required)

Allows a script to set the key used to terminate its execution. The default key for this action is the shutter full press key. However, for scripts that need to capture a shutter full press, an alternate key can be selected. Takes a string argument using the same values used by is_pressed / press / click / release.

Note : you can use set_exit_key("no_key") so that there is no key sequence that forces the termination of a running script

set_yield

This command controls how CPU time is allocated to running scripts.

You can adjust these values to allow complex scripts to run more quickly. This will cause less CPU to be available for other tasks, which may have side effects. Note that increasing these values will not make operations that happen outside of script code (e.g. shooting, motion detection) any faster.

The script task yields (sleep for 10ms) when either condition is met. Values are treated as unsigned, so -1 can be used to effectively disable either condition.

MAX_LINES is the maximum number of lines to execute in a single iteration of the script task. Default is 1, meaning that ubasic scripts take at least 10ms to execute each line.

MAX_MS is the maximum number of milliseconds a single iteration of the script task is allowed to run for before yielding. Default is 10.

The value has a resolution of 10ms, and is checked after each line. Since the resolution is 10ms, and the start of a script iteration does not necessarily begin in sync with the system clock, the actual time may be less than ten ms.

Passing zero for either value resets it to default.

lua usage:

old_max_count,old_max_ms=set_yield(<MAX_COUNT>,<MAX_MS>)

MAX_COUNT is the maximum number of lua VM instructions to execute in a single iteration of the script task, divided by 100. Default is 25, meaning a maximum of 2500 VM instructions will be executed.

MAX_MS is as described for ubasic, except it is checked every 100 VM instructions rather than every line.

The return values are the previous values of MAX_COUNT and MAX_MS. Libraries that need to adjust these values should save and restore the values. Passing nil for either value resets it to the default.

In Lua, calls to lua code from within C (for example, using pcall()) cannot yield. However the VM calls and time will still be counted, so a yield will occur within 100 instructions after the C call if the limits are exceeded.

(since changeset #1434, an incompatible variant for ubasic was introduced in changeset #1427)

get_curve_file

Lua commands to report on tone curve file currently loaded. Returns path as a string.