summaryrefslogtreecommitdiff
path: root/macros/Hardware/AVR/AVRADCSetup.sci
diff options
context:
space:
mode:
authorAbhinav Dronamraju2017-09-29 22:00:40 +0530
committerAbhinav Dronamraju2017-09-29 22:00:40 +0530
commit9bc7ad78e8d7d7acc4b9387aa592542832e80b31 (patch)
tree7fce060665a91de5e5adb12d02003351c3d1fdfc /macros/Hardware/AVR/AVRADCSetup.sci
parent33755eb085a3ca8154cf83773b23fbb8aac4ba3e (diff)
parentac0045f12ad3d0938758e9742f4107a334e1afaa (diff)
downloadscilab2c-9bc7ad78e8d7d7acc4b9387aa592542832e80b31.tar.gz
scilab2c-9bc7ad78e8d7d7acc4b9387aa592542832e80b31.tar.bz2
scilab2c-9bc7ad78e8d7d7acc4b9387aa592542832e80b31.zip
NEW FEATURES AND NEW FUNCTIONS
Diffstat (limited to 'macros/Hardware/AVR/AVRADCSetup.sci')
-rw-r--r--macros/Hardware/AVR/AVRADCSetup.sci49
1 files changed, 49 insertions, 0 deletions
diff --git a/macros/Hardware/AVR/AVRADCSetup.sci b/macros/Hardware/AVR/AVRADCSetup.sci
new file mode 100644
index 00000000..603873b3
--- /dev/null
+++ b/macros/Hardware/AVR/AVRADCSetup.sci
@@ -0,0 +1,49 @@
+// Copyright (C) 2017 - IIT Bombay - FOSSEE
+//
+// This file must be used under the terms of the CeCILL.
+// This source file is licensed as described in the file COPYING, which
+// you should have received as part of this distribution. The terms
+// are also available at
+// http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
+// Organization: FOSSEE, IIT Bombay
+// Email: toolbox@scilab.in
+
+function AVRADCSetup(prescaler,adc_ref)
+// Function to initialise ADC of AVR
+//
+// Calling Sequence
+// AVRADCSetup(uint8 prescaler, uint8 adc_ref)
+//
+// Parameters
+// prescaler: prescaler to be used for generating ADC clock (0-7)
+// adc_ref : reference voltage to be used for ADC conversion
+//
+// Description
+// This function initialises ADc of AVR with given parameters. 'prescaler' is needed for deciding ADC clock. ADC clock should be between 50KHz and 200KHz and it given as (MCU clock/2^prescaler). Select appropriate prescaler depending on MCU clock. 'adc_ref' selects one of the available reference voltage sources available.
+//
+// The adc_ref can take the following values-
+// <itemizedlist>
+// <listitem><para>0 -> Voltage on VREF pin</para></listitem>
+// <listitem><para>1 -> Voltage on AVCC pin</para></listitem>
+// <listitem><para>2 -> Internal 2.56 reference voltage</para></listitem>
+// </itemizedlist>
+//
+// This is curretly dummy function. It provides no functionality but is required for providing support for generating C code for AVR.
+//
+// Examples
+// AVRADCSetup(128,0)
+// See also
+// AVRReadADC
+//
+// Authors
+// Siddhesh Wani
+// Ashish Kamble
+//
+
+if(prescaler>=8)
+disp("Error : Invalid input argument ''prescaler'' in AVRADCSetup function.");
+end
+if(adc_ref>=3) then
+disp("Error : Invalid input argument ''adc_ref'' in AVRADCSetup function.");
+end
+endfunction