summaryrefslogtreecommitdiff
path: root/macros/Hardware/AVR/AVRDigitalIn.sci
blob: 54eb327b3016aefa609a8a62ef61c9f386d15b68 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
// 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 state = AVRDigitalIn(port,pin)
// Function to get state (high\low) of a digital input pin on AVR
//
// Calling Sequence
//     state=AVRDigitalIn(port,pin)
//
// Parameters
//     port : port of microcontroller to be used
//     pin : pin of port (mentioned above) to be used
//   Returns  
//     state : state of an input pin (HIGH\LOW)
//
// Description
//     Each AVR microcontroller has pins which can be configured as digital
//     inputs. These are normally divided among some 'ports' (group of pins).
//     User has to select one of these port and which pin of that port as 
//     digital input.      
//
// Examples
//     pinA0 = AVRDigitalIn(1,0)   //To read state on pin 0 of port A
//
// See also
//     AVRDigitalOut AVRDigitalSetup
//
//
// Authors
//     Siddhesh Wani Ashish Kamble
//
// This is curretly dummy function. It provides no functionality but is required 
// for providing support for generating C code for AVR.

if((port==0)|(port>=5)) then 
disp("Error : Inavalid input argument ''port'' in AVRDigitalIn function.");
end
if(pin>=8) then 
disp("Error : Inavalid input argument ''pin'' in AVRDigitalIn function.");
end
state = 0;
endfunction