Wikia

CHDK Wiki

Changes: Script commands

Edit

Back to page

(set_yield)
 
(39 intermediate revisions by 4 users not shown)
Line 10: Line 10:
   
 
Returns the value of the specified CHDK configuration item. These are the items set in the CHDK menus. Use the index number found in CHDK source file [http://subversion.assembla.com/svn/chdk/trunk/core/conf.c conf.c] in the structure conf_info[].
 
Returns the value of the specified CHDK configuration item. These are the items set in the CHDK menus. Use the index number found in CHDK source file [http://subversion.assembla.com/svn/chdk/trunk/core/conf.c conf.c] in the structure conf_info[].
  +
  +
'''uBASIC usage:'''
  +
  +
v=get_config_value <configID>
   
 
'''Lua usage:'''
 
'''Lua usage:'''
Line 29: Line 33:
 
*id_max = get_config_value(0); id_max is the highest ID value in conf_info[]
 
*id_max = get_config_value(0); id_max is the highest ID value in conf_info[]
 
Example:
 
Example:
*print("Restart lua on error?", get_config_value(238)) --0=no; 1=yes
+
print("Restart lua on error?", get_config_value(238)) --0=no; 1=yes
*output: Restart lua on error? 0
+
  +
outputs: Restart lua on error? 0
  +
  +
'''Note :''' effective with CHDK 1.3, you can access config values by name -> [http://chdk.setepontos.com/index.php?topic=9602.10 CHDK Forum : Suggestion for CHDK configuration file saving]
   
 
==set_config_value==
 
==set_config_value==
   
 
Sets the value of the specified CHKD configuration value. Configuration values are selected by an index number found in CHDK source file [http://subversion.assembla.com/svn/chdk/trunk/core/conf.c conf.c] in the structure conf_info[].
 
Sets the value of the specified CHKD configuration value. Configuration values are selected by an index number found in CHDK source file [http://subversion.assembla.com/svn/chdk/trunk/core/conf.c conf.c] in the structure conf_info[].
  +
  +
'''uBASIC usage:'''
  +
  +
set_config_value <configID> <value>
   
 
'''Lua usage:'''
 
'''Lua usage:'''
Line 43: Line 51:
 
Example:
 
Example:
   
*set_config_value(238, 1) --conf.debug_lua_restart_on_error = 1 yes; 0 no
+
set_config_value(238, 1) --conf.debug_lua_restart_on_error = 1 yes; 0 no
*Look in CHDK menu > Miscellaneous Stuff > Debug Parameters > Restart Lua on error (now has a dot beside it)
+
  +
look in CHDK menu > Miscellaneous Stuff > Debug Parameters > Restart Lua on error now has a dot beside it.
  +
  +
'''Note ''': effective with CHDK 1.3, you can access config values by name -> [http://chdk.setepontos.com/index.php?topic=9602.10 CHDK Forum : Suggestion for CHDK configuration file saving]
   
 
==get_movie_status==
 
==get_movie_status==
   
Returns status of movie recording.
+
Returns the video recording status.
   
can be used for stuff like checks instead of sleep commands. if get_movie_status is 0 or 1, movie recording is stopped or paused. if get_movie_status is 4, recording is in progress. if it is 5, recording is stopped but camera is still writing movie to sdcard.
+
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==
 
==set_movie_status==
   
is experimental and so far only works on a720 & s3is properly. using this command you can pause, unpause and stop video recordings.
+
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 movie (will not work on all cameras, typically they freeze or shutdown after 2 seconds !)
+
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
+
set_movie_status 2 will unpause (restart) recording.
   
 
set_movie_status 3 will stop video recording (this should work on all types of cameras).
 
set_movie_status 3 will stop video recording (this should work on all types of cameras).
 
   
 
==get_video_button==
 
==get_video_button==
Line 72: Line 79:
   
 
==get_display_mode==
 
==get_display_mode==
returns LCD display mode (in record mode only) regardless of propset used by the camera (one of the features to help get chdk scripts universal)
+
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
   
(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==
 
==get_propset==
Line 124: Line 131:
   
 
==get_nd_present==
 
==get_nd_present==
returns 0 if no [[ND_Filter|ND Filter]] present, 1 if ND present and real diaphragm NOT present, 2 if both ND & diaphragm present.
+
returns whether the camera has a switchable [[ND_Filter|ND Filter]],  and by inference whether it has an adjustable aperture (as all Canon P&S cameras have at least one or the other)
  +
  +
Return Value :
  +
  +
0 = adjustable aperture only (camera does not have a switchable ND filter)
  +
  +
1 = ND filter only (camera does not have an adjustable aperture)
  +
  +
2 = camera has both ND filter and adjustable aperture 
   
 
==get_histo_range==
 
==get_histo_range==
Line 324: Line 331:
   
 
==set_backlight()==
 
==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.)
+
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: <tt>set_backlight(x)</tt> (Lua) or <tt>set_backlight x</tt> (uBASIC), where '''0''' disables backlight and '''1''' enables it.
+
Usage:
  +
  +
*<tt>set_backlight(x)</tt>       ''(Lua) '' 
  +
  +
*<tt>set_backlight x    </tt>  ''(uBASIC)''
  +
  +
where '''0''' disables backlight and '''1''' enables the backlight.
  +
  +
Notes :
   
* Note: Camera enables 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.
+
* 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.
* Note: If you accidentally exit a script while 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.
+
* 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.
 
* An example script can be found here: [http://chdk.setepontos.com/index.php/topic,2744.msg27703.html#msg27703]
 
* An example script can be found here: [http://chdk.setepontos.com/index.php/topic,2744.msg27703.html#msg27703]
   
==set_aflock==
+
==set_lcd_display()==
''(since version 0.9.2 / changeset #681)''
+
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:  
  +
  +
*<tt>set_lcd_display(x)   </tt>'' (Lua) ''  
  +
  +
*<tt>set_lcd_display x</tt>         ''(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. 
  +
* It may be necessary to set Review mode to Off in the Canon menu for this to work reliably 
  +
* 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.
  +
* An example script can be found here: [http://chdk.setepontos.com/index.php?topic=10551.msg106578#msg106578]
  +
* Available in CHDK version 1.2.0 or newer
  +
  +
==set_draw_title_line==
  +
'''(CHDK Version 1.3.0 or greater required)'''
  +
  +
This function enables / disables the drawing of the CHDK OSD title line at the bottom of the LCD screen ( <ALT> and current script name )
  +
*''set_draw_title_line(0)'' - disables the display of the <ALT> symbol and the currently loaded script name
  +
*''set_draw_title_line(1)'' - enables the display of the <ALT> symbol and the currently loaded script name 
  +
Note : Lua syntax shown -  uBASIC  syntax is  ''set_draw_title_line 0''    and    ''set_draw_title_line 1''
  +
  +
==get_draw_title_line==
  +
'''(CHDK Version 1.3.0 or greater required)'''
  +
  +
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
 
Lock/unlock autofocus
   
 
Usage:
 
Usage:
   
<tt>Lua: set_aflock(x)</tt>
+
: <tt>Lua: set_aflock(x)</tt>
   
<tt>uBASIC:</tt> <tt>set_aflock x</tt>
+
: <tt>uBASIC:</tt> <tt>set_aflock x</tt>
   
 
where '''1''' locks the autofocus and '''0''' unlocks it.
 
where '''1''' locks the autofocus and '''0''' unlocks it.
Line 353: Line 392:
 
release "shoot_half"<br />
 
release "shoot_half"<br />
 
set_aflock 1</tt>
 
set_aflock 1</tt>
  +
  +
Note : may not work for all cameras (unfortunately).
  +
  +
==set_mf==
  +
Lock/unlock Canon manual focus (MF) mode. ( CHDK 1.3.0 or later only)
  +
  +
Usage:
  +
  +
: <tt>Lua: set_mf(x)</tt>
  +
  +
: <tt>uBASIC:</tt> <tt>set_mf x</tt>
  +
  +
where '''1''' locks the camera in MF mode and '''0''' unlocks it.
  +
  +
When used with Lua, returns "0" if MF is not supported and "1" if it is supported on the camera using the function.
  +
  +
Similar to set_aflock(), this function place the camera into a mode where SD override commands ( set_focus ) can be used and the value requested will be maintained across multiple shots.
  +
  +
Note : works on many cameras that do not have a Canon MF mode. But it may not work for all cameras (unfortunately).
  +
  +
==set_aelock==
  +
'''(CHDK Version 1.3.0 or greater required)'''
  +
  +
<span style="font-size:13px;line-height:21px;">Lock/unlock auto exposure adjust.</span>
  +
  +
Usage:
  +
  +
: <tt>Lua: set_aelock(x)</tt>
  +
  +
: <tt>uBASIC:</tt> <tt>set_eflock x</tt>
  +
  +
where '''1''' locks autoexposure adjustments and '''0''' unlocks them.
   
 
==set_record(state)==
 
==set_record(state)==
Line 406: Line 477:
   
 
==get_capture_mode==
 
==get_capture_mode==
Ubasic only, not needed in lua, use [[Lua/Lua_Reference#get_mode|get_mode()]] instead.
+
uBASIC only, not needed in Lua, use [[Lua/Lua_Reference#get_mode|get_mode()]] instead.
   
 
returns the current camera automatic image mode, or 0 if camera is in play mode or 0 if there is no modemap entry
 
returns the current camera automatic image mode, or 0 if camera is in play mode or 0 if there is no modemap entry
Line 418: Line 489:
   
 
==set_console_autoredraw==
 
==set_console_autoredraw==
''New commands for the customizable script console, introduced with changeset #899, updated in changeset #1394.''
 
   
'''set_console_autoredraw('''-1|0|1''')''' --> enable or disable automatic rewrite/refresh of the console.
+
'''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:
 
Parameters:
'''-1''' = log only (update to log file but not to display)
 
''' 0''' = disable
 
''' 1''' = enable (update to log file and display)
 
   
==console_redraw==
+
* -1 = text from print statement is not added to console buffer
''New commands for the customizable script console, introduced with changeset '''#899''' ''
 
   
  +
* 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
 
'''console_redraw()''' --> manually refresh/rewrite the script console
   
Line 458: Line 533:
 
* Restore in lua should not using any functions that yield, such as sleep, key press / release etc.
 
* Restore in lua should not using any functions that yield, such as sleep, key press / release etc.
   
==set_yield==
+
==set_exit_key==
This command controls how CPU time is allocated to running scripts.
+
'''(CHDK Version 1.3.0 or greater required)'''
   
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.
+
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.
   
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.
+
'''Note : ''' you can use  '' set_exit_key("no_key")''   so that there is no key sequence that forces the termination of a running script
   
Commands that wait (such as sleep, wait_click, md_detect_motion etc) or send key presses yield immediately.
+
==set_yield==
  +
This command controls how much of the camera's CPU time is allocated to running scripts.
   
ubasic usage:
+
The CHDK script engine yields (sleep for 10ms) when either a specified number of script lines have been executed or a specified time period has passed.  You can adjust these specified values to allow complex scripts to run more quickly. However, this will cause less CPU to be available for other camera 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. Specified values are treated as unsigned, so -1 can be used to effectively disable either condition by making the number of lines or time period very large.
  +
  +
Commands that wait (such as sleep, wait_click, md_detect_motion etc) or send key presses yield immediately.  
  +
  +
'''ubasic usage:'''
   
 
<tt>set_yield &lt;MAX_LINES&gt; &lt;MAX_MS&gt;</tt>
 
<tt>set_yield &lt;MAX_LINES&gt; &lt;MAX_MS&gt;</tt>
Line 479: Line 554:
 
Passing zero for either value resets it to default.
 
Passing zero for either value resets it to default.
   
lua usage:
+
'''lua usage''':
   
 
<tt>old_max_count,old_max_ms=set_yield(&lt;MAX_COUNT&gt;,&lt;MAX_MS&gt;)</tt>
 
<tt>old_max_count,old_max_ms=set_yield(&lt;MAX_COUNT&gt;,&lt;MAX_MS&gt;)</tt>
Line 490: Line 565:
   
 
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.
 
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==
 
==get_curve_file==
Line 638: Line 711:
   
 
===sv96_real_to_market===
 
===sv96_real_to_market===
converts an sv96 value to a "market" ISO sensitivity value
+
converts a "real" sv96 value to a "market" sv96 value
   
 
===sv96_market_to_real===
 
===sv96_market_to_real===
converts an sv96 value to a "real" ISO sensitivity value
+
converts an "market" sv96 value to a "real" sv96 value
   
 
===aperture_to_av96===
 
===aperture_to_av96===

Latest revision as of 22:37, April 6, 2014

Note: This is work in progress... Please add. Fe50 01:21, December 28, 2010 (UTC)



Additional uBASIC and Lua Scripting CommandsEdit

Notice

CHDK scripting basics and the most commonly used scripting commands are explained on the UBASIC/TutorialScratchpad page. Lua specific commands are documented at Lua/Lua_Reference. A complete cross reference of all scripting commands can be found here : CHDK Scripting Cross Reference Page


get_config_valueEdit

Returns the value of the specified CHDK configuration item. These are the items set in the CHDK menus. Use the index number found in CHDK source file conf.c in the structure conf_info[].

uBASIC usage:

v=get_config_value <configID>

Lua usage:

int1[,int2][,str1][,table1]=get_config_value(configid[,default])

  • int1 = config value integer
  • int1, int2 = positions of OSD elements (x,y)
  • str1 = config value string (eg. a file path)
  • table1 = config value fields
  • configid = index number from conf.c structure conf_info[]
  • default = message value, when ID was not found
  • nil = error (ID not found and no default given)
  • id_max = get_config_value(0); id_max is the highest ID value in conf_info[]

Example:

print("Restart lua on error?", get_config_value(238)) --0=no; 1=yes

outputs: Restart lua on error? 0

Note : effective with CHDK 1.3, you can access config values by name -> CHDK Forum : Suggestion for CHDK configuration file saving

set_config_valueEdit

Sets the value of the specified CHKD configuration value. Configuration values are selected by an index number found in CHDK source file conf.c in the structure conf_info[].

uBASIC usage:

set_config_value <configID> <value>

Lua usage:

set_config_value(<ConfigID>[,int1][,int2][,str1][,table1])

  • returns true for success or false for error

Example:

set_config_value(238, 1) --conf.debug_lua_restart_on_error = 1 yes; 0 no

look in CHDK menu > Miscellaneous Stuff > Debug Parameters > Restart Lua on error now has a dot beside it.

Note : effective with CHDK 1.3, you can access config values by name -> CHDK Forum : Suggestion for CHDK configuration file saving

get_movie_statusEdit

Returns the video recording 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_statusEdit

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_buttonEdit

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_modeEdit

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_propsetEdit

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_stepsEdit

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_countEdit

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.

On SD1000 returns file number of last exposure.

get_drive_modeEdit

returns drivemode (as described on the property page)

0 = single 1 = continuous 2 = timer (on Digic II) 3 = timer (on Digic III)

The timer issue will somewhat make it difficult to use it in universal scripts, however together with a get_propset this should be do-able.

get_flash_modeEdit

returns flash mode (0,1,2 = flash auto, flash on, flash off)

get_flash_readyEdit

returns 1 if flash is ready and charged,  0 otherwise

get_IS_modeEdit

returns IS mode

0,1,2,3 = continous, shoot only, panning, off

get_orientation_sensorEdit

regardless of Digic II / Digic III it will return the orientation sensor's degrees.

get_nd_presentEdit

returns whether the camera has a switchable ND Filter,  and by inference whether it has an adjustable aperture (as all Canon P&S cameras have at least one or the other)

Return Value :

0 = adjustable aperture only (camera does not have a switchable ND filter)

1 = ND filter only (camera does not have an adjustable aperture)

2 = camera has both ND filter and adjustable aperture 

get_histo_rangeEdit

Usage:   get_histo_range <from> <to>   returns percent of values between <from> and <to> in histogram data.

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.

Sample:

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

shot_histo_enableEdit

setting to 1 enables building of shot histogram data, 0 disables (see get_histo_range)

autostartedEdit

returns 1 (true) if script was autostarted

is_pressed "key"Edit

checks if the specified key is being pressed when the command is called,  returns 1 for true,  0 for false

get_shootingEdit

UBASIC : returns 1 if half_press active and focus+exposure is set,  0 otherwise.  

Lua : return boolean true if half_press active and focus+exposure is set , false otherwise

Note : based on propcase variable 205 (Digic II) / 206 (Digic III) / 210 (Digic IV & V)

get_evEdit

returns propcase 25 (Digic II) / 107 (Digic III)

set_evEdit

sets propcases 25 & 26 (Digic II) / 107 & 207 (Digic III)

get_autostart & set_autostartEdit

read and write conf.script_autostart (0=off, 1=on, 2=once)

get_temperatureEdit

"get_temperature 0", 0 returns optical, 1 returns CCD, and 2 returns battery temp

This can be used to both assign a variable or to print directly
Example:
a = get_temperature 0
print "Optical Temp:",a

print "Battery Temp:",get_temperature 2

select/case functionEdit

Here's a thread describing the use of the new uBASIC "select/case" feature:
http://chdk.setepontos.com/index.php/topic,1995.0.html
Syntax:
select EXPRESSION
  case EXPR. [to EXPR.] | [,EXPR.2[, ...]]; STATEMENT
  .
  .
  [case_else STATEMENT]
end_select
Sample:
for x=1 to 7
  select x
    case 1; gosub "new"
    case 7; goto "EXIT"
    case 2,4; print "x=2 | x=4"
    case 2 to 5; print "x=3 | x=5"
    case_else print"x=6"
  end_select
next x
:EXIT
  print "ready"
  end
:new
  print "sub"
  for y=1 to 2
    select y
      case 1; print "y=1"
      case_else print"y=2"
    end_select
  next y
return

changed RANDOM commandEdit

Now you can supply two values min & max
Example: "playsound random 3 6" will play the sounds 3,4,5,6 in random order (if repeated in a while loop)

playsoundEdit

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)
  • for Lua the command is play_sound (Example: "play_sound(3)")
  • sound 7 plays even on a muted camera (tested on A610)

print_screenEdit

Usage: print_screen(123) (in Lua) or print_screen 123 (in uBasic) creates LOG_0123.TXT in the \CHDK\LOGS folder

  • logging is disabled by 'print_screen(false)' in Lua or 'print_screen 0' in uBasic
  • 'print_screen(0)' in Lua or 'print_screen 10000' in uBasic writes to LOG_0000.TXT
  • 'print_screen(1)'  of print_screen(true' 'in Lua opens log file LOG_0001.TXT in overwrite mode
  • 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_timeEdit

(since changeset #497)

Returns elements of the camera's current time.

Usage: get_time 0 (returns seconds), 1 (minute), 2 (hour), 3 (day), 4 (month), 5 (year).

Example:

a=get_time 0

will set the value of "a" to the current number of seconds.

(command also exists in Lua, though must be fed with CHARS, see Lua Reference)

get_modeEdit

(since changeset #497)

Returns whether record mode or playback mode is active, useful for closing scripts that are meant to be run in a certain mode (like the majority of all available scripts).

Returns 0 in record mode, 1 in playback mode, 2 when mode dial is set to videomode AND camera is in record mode (2 since changeset #499)

get_qualityEdit

(since changeset #497)

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_resolutionEdit

(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_qualityEdit

(since changeset #497)

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

(not available in Lua yet)

set_resolutionEdit

(since changeset #497)

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

(not available in Lua yet)

get_platform_idEdit

(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()Edit

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.
  • An example script can be found here: [1]

set_lcd_display()Edit

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. 
  • It may be necessary to set Review mode to Off in the Canon menu for this to work reliably 
  • 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.
  • An example script can be found here: [2]
  • Available in CHDK version 1.2.0 or newer

set_draw_title_lineEdit

(CHDK Version 1.3.0 or greater required)

This function enables / disables the drawing of the CHDK OSD title line at the bottom of the LCD screen ( <ALT> and current script name )

  • set_draw_title_line(0) - disables the display of the <ALT> symbol and the currently loaded script name
  • set_draw_title_line(1) - enables the display of the <ALT> symbol and the currently loaded script name 

Note : Lua syntax shown -  uBASIC  syntax is  set_draw_title_line 0    and    set_draw_title_line 1

get_draw_title_lineEdit

(CHDK Version 1.3.0 or greater required)

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_aflockEdit

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

Note : may not work for all cameras (unfortunately).

set_mfEdit

Lock/unlock Canon manual focus (MF) mode. ( CHDK 1.3.0 or later only)

Usage:

Lua: set_mf(x)
uBASIC: set_mf x

where 1 locks the camera in MF mode and 0 unlocks it.

When used with Lua, returns "0" if MF is not supported and "1" if it is supported on the camera using the function.

Similar to set_aflock(), this function place the camera into a mode where SD override commands ( set_focus ) can be used and the value requested will be maintained across multiple shots.

Note : works on many cameras that do not have a Canon MF mode. But it may not work for all cameras (unfortunately).

set_aelockEdit

(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)Edit

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)Edit

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)Edit

  • 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

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

is_capture_mode_valid(modenum)Edit

modenum is a CHDK mode value

returns is true if modenum is a a valid mode in the cameras modemap, otherwise false

(since version 0.9.9 / changeset #847)

get_capture_modeEdit

uBASIC only, not needed in Lua, use get_mode() instead.

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_layoutEdit

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_autoredrawEdit

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_redrawEdit

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

reboot([file])Edit

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)

restoreEdit

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_keyEdit

(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_yieldEdit

This command controls how much of the camera's CPU time is allocated to running scripts.

The CHDK script engine yields (sleep for 10ms) when either a specified number of script lines have been executed or a specified time period has passed.  You can adjust these specified values to allow complex scripts to run more quickly. However, this will cause less CPU to be available for other camera 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. Specified values are treated as unsigned, so -1 can be used to effectively disable either condition by making the number of lines or time period very large.

Commands that wait (such as sleep, wait_click, md_detect_motion etc) or send key presses yield immediately.  

ubasic usage:

set_yield <MAX_LINES> <MAX_MS>

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.

get_curve_fileEdit

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

(only for 10bit-RAW cameras)

set_curve_fileEdit

Lua commands to load a tone curve file, set_curve_file(<path>).

(only for 10bit-RAW cameras)

get_curve_stateEdit

Lua commands to determine if tone curve file is active or disabled. 0, 1, 2, 3, 4 = None, Custom, +1EV, +2EV, AutoDR

(only for 10bit-RAW cameras)

set_curve_stateEdit

Lua commands to enable/disable tone curve file usage. 0, 1, 2, 3, 4 = None, Custom, +1EV, +2EV, AutoDR

(only for 10bit-RAW cameras)

get_focus_modeEdit

returns focus mode, 0=auto, 1=MF, 3=inf., 4=macro, 5=supermacro

get_focus_stateEdit

returns focus status, > 0 focus successful, =0 not successful, < 0 MF

get_focus_okEdit

returns 0=focus not ok, 1=ok if get_focus_state<>0 and get_shooting=1

get_focal_lengthEdit

get current lens focal length * 1000, e.g. 5800 = focal length 5.8

get_min_stack_distEdit

Calculates the minimum object distance in mm. This is required for focus stacking.

(Only uBasic, in Lua use get_dofinfo() as table for all dof related values)

set_file_attributesEdit

Set the file attributes, 0x1 = read-only, 0x2 = hidden, 0x20 = archiv

set_file_attributes(<file>, <attributes>), e.g. set_file_attributes(file_name, bitor(bitor(0x1,0x2),0x20)) sets all attributes.

(only for Lua)

get_partitionInfoEdit

Returns a table with informations about the partition.

part=get_partitionInfo()

  • part.count - number of partitions
  • part.active - active partition starting with 1
  • part.type - type of the active partition
  • part.size - size of the active partition

(only for Lua)

swap_partitionEdit

Change the partition. swap_partition(n) -> n = num of partition

(only for Lua)

get_buildinfoEdit

Returns a table of informations about camera & CHDK.

bi=get_buildinfo()

  • bi.platform
  • bi.platsub
  • bi.version
  • bi.build_number
  • bi.build_revision
  • bi.build_date
  • bi.build_time
  • bi.os
  • bi.platformid

(only for Lua)

get_dofinfoEdit

Returns a table with dof and focus related informations.

dof=get_dofinfo()

  • dof.hyp_valid [boolean] - Is hyperfocal distance valid?
  • dof.focus_valid [boolean] - Is focus valid?
  • dof.aperture [x 1000] - aperture
  • dof.coc [x 1000 mm] - circle of confusion
  • dof.focal_length [x 1000 mm] - focal length
  • dof.eff_focal_length [x 1000 mm] - 35mm equivalent focal length
  • dof.focus [mm] - focus distance
  • dof.near [mm] - near limit
  • dof.far [mm] - far limit
  • dof.dof [mm] - DOF
  • dof.hyp_dist [mm] - hyperfocal distance
  • dof.min_stack_dist [mm] - smallest meaningful stack distance

(only for Lua)

get_video_detailsEdit

<<deprecated>>

textboxEdit

Provides a text input box. Usage:

textbox( "title" , "message" , "default_string" , max_len)

where:

  • "title" - string displayed as the title of the box; default is "Text box"
  • "message" - short message for the user; default is "Enter text"
  • "default_string" - appears as the string before user starts editing; default is an emtpy string
  • max_len - the maximum length of the input; default is 30.

Function returns a string typed or edited by user, when the user submits.

User can type by pressing left/up/right/down buttons in a similar way to mobile phone writing.

  • SHOOT_HALF switches between lower case/upper case/digits/special
  • ZOOM_IN od DISPLAY- spacebar
  • ZOOM_OUT or ERASE - delete
  • JOGDIAL moves the cursor
  • MENU switches to "navigate cursor" mode, where you can only move the cursor or add a space by DISPLAY
  • MENU once again switches to OK/CANCEL - user can submit or cancel the editing.

(Lua only)

APEX96 Conversion FunctionsEdit

(CHDK Version 1.3.0 or greater required)

iso_to_sv96Edit

converts an ISO sensitivity value into sv96 units

sv96_to_isoEdit

converts an sv96 value to an ISO sensitivity value

iso_real_to_marketEdit

converts a "real" ISO sensitivity value to a "market" ISO sensitivity value

iso_market_to_realEdit

converts a "market" ISO sensitivity value to a "real" ISO sensitivity value

sv96_real_to_marketEdit

converts a "real" sv96 value to a "market" sv96 value

sv96_market_to_realEdit

converts an "market" sv96 value to a "real" sv96 value

aperture_to_av96Edit

converts an aperature setting (f-stop) to av96 units - f-stop is scaled by 1000

av96_to_apertureEdit

converts an av96 value to aperature setting (f-stop) *1000 units

usec_to_tv96Edit

converts shutter speed in uSec to a tv96 value

tv96_to_usecEdit

converts a tv96 value to shutter speed in units of uSec

seconds_to_tv96Edit

converts a fractional value to tv96 units - takes a numerator and denominator as parameters

APEX96 Example Lua ScriptEdit

--[[
@title APEX96
@param i ISO value
@default i 200 
@param l Log
@default l 0
@range l 0 1
--]]
set_console_layout(0, 0, 44, 16)
print_screen(l)
 
sv96 = iso_to_sv96(i)
print("ISO "..i.." = SV96 "..sv96)
iso=sv96_to_iso(sv96)
print("SV96 "..sv96.." = ISO" , iso )
 
isom=iso_real_to_market(i)
isor=iso_market_to_real(i)
print("ISO "..i.." real  = ISO"..isom.." market")
print("ISO "..i.." market = ISO"..isor.." real")
 
sv96m=sv96_real_to_market(sv96)
sv96r=sv96_market_to_real(sv96)
print("SV96 "..sv96.." real = "..sv96m.." market")
print("SV96 "..sv96.." market = "..sv96r.." real")
 
fstop=5600
av96 = aperture_to_av96(fstop)
print("f"..(fstop/1000).."." ..((fstop%1000)/100).." = AV96 "..av96)
fstop = av96_to_aperture(av96)
print("AV96 "..av96.." = f"..(fstop/1000).."."..(fstop%1000)/100)
 
shutter=10000
tv96=usec_to_tv96(shutter)
print((shutter/1000000).."sec ".. (shutter/1000).." msec = TV96 "..tv96)
shutter=tv96_to_usec(tv96)
print("TV96 "..tv96.." = "..(shutter/1000000).."sec ".. (shutter/1000).." msec")
 
n=1
d=60
tv96=seconds_to_tv96(n,d)
print(n.."/"..d.." = ", tv96, "in apex96 units" )
shutter=tv96_to_usec(tv96)
print("TV96 "..tv96.." = "..(shutter/1000000).."sec ".. (shutter/1000).." msec")

Around Wikia's network

Random Wiki