Difference between revisions of "Component: RTC (MCP7940N) (Storage)"
(XML import) |
(XML import) |
||
(One intermediate revision by the same user not shown) | |||
Line 4: | Line 4: | ||
|- | |- | ||
| width="20%" style="color: gray;" | Author | | width="20%" style="color: gray;" | Author | ||
− | | | + | | Matrix TSL |
|- | |- | ||
| width="20%" style="color: gray;" | Version | | width="20%" style="color: gray;" | Version | ||
Line 117: | Line 117: | ||
<span style="font-weight: normal;"><u>Channel</u></span> | <span style="font-weight: normal;"><u>Channel</u></span> | ||
− | This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''CHANNEL''. | + | This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''cal_i2c1::CHANNEL''. |
− | + | Channel selection | |
<span style="font-weight: normal;"><u>SDA</u></span> | <span style="font-weight: normal;"><u>SDA</u></span> | ||
− | This property is of type ''Single digital pin'' and can be referenced with the variable name ''SDA''. | + | This property is of type ''Single digital pin'' and can be referenced with the variable name ''cal_i2c1::SDA''. |
+ | |||
+ | Pin used for SDA (data signal) | ||
+ | |||
+ | <span style="font-weight: normal;"><u>SDA Remap Pin</u></span> | ||
+ | |||
+ | This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''cal_i2c1::SDAPins''. | ||
''<span style="color:red;">No additional information</span>'' | ''<span style="color:red;">No additional information</span>'' | ||
Line 131: | Line 137: | ||
<span style="font-weight: normal;"><u>SCL</u></span> | <span style="font-weight: normal;"><u>SCL</u></span> | ||
− | This property is of type ''Single digital pin'' and can be referenced with the variable name ''SCL''. | + | This property is of type ''Single digital pin'' and can be referenced with the variable name ''cal_i2c1::SCL''. |
+ | |||
+ | Pin used for SCL (clock signal) | ||
+ | |||
+ | <span style="font-weight: normal;"><u>SCL Remap Pin</u></span> | ||
+ | |||
+ | This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''cal_i2c1::SCLPins''. | ||
+ | |||
+ | ''<span style="color:red;">No additional information</span>'' | ||
+ | |||
+ | |||
+ | |||
+ | <span style="font-weight: normal;"><u>Stop Delay</u></span> | ||
+ | |||
+ | This property is of type ''True or false'' and can be referenced with the variable name ''cal_i2c1::StopDel''. | ||
+ | |||
+ | On older microcontroller devices there is a potential for the I2C hardware channel to lock up if there is not | ||
+ | |||
+ | a 10ms delay between an I2C stop event and the next I2C start event. | ||
+ | |||
+ | |||
+ | |||
+ | Most modern microcontrollers will not have a problem so this property can be disabled to speed up the | ||
+ | |||
+ | I2C communications. | ||
+ | |||
+ | <span style="font-weight: normal;"><u>Baud Select</u></span> | ||
+ | |||
+ | This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''cal_i2c1::BAUD_LIST''. | ||
+ | |||
+ | Baud rate option selector | ||
+ | |||
+ | <span style="font-weight: normal;"><u>Baud Rate</u></span> | ||
+ | |||
+ | This property is of type ''Signed integer'' and can be referenced with the variable name ''cal_i2c1::BAUD''. | ||
+ | |||
+ | Baud rate to be used | ||
+ | |||
+ | <span style="font-weight: normal;"><u>Scope Traces</u></span> | ||
+ | |||
+ | This property is of type ''True or false'' and can be referenced with the variable name ''cal_i2c1::ScopeTraces''. | ||
+ | |||
+ | Selects if the component pin connections are automatically generated on the data recorder window or not. | ||
+ | |||
+ | Yes: Automatically add the component pins to a group on the data recorder which will reflect the sim data during simultion. | ||
+ | |||
+ | No: Do not show the pin signals on the data recorder window. | ||
+ | |||
+ | <span style="font-weight: normal;"><u>Console Data</u></span> | ||
+ | |||
+ | This property is of type ''True or false'' and can be referenced with the variable name ''cal_i2c1::ConsoleData''. | ||
+ | |||
+ | Selects if the console data is automatically generated or not | ||
+ | |||
+ | <span style="font-weight: normal;"><u>Injector</u></span> | ||
+ | |||
+ | This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''cal_i2c1::Injector''. | ||
''<span style="color:red;">No additional information</span>'' | ''<span style="color:red;">No additional information</span>'' |
Latest revision as of 10:31, 9 May 2018
Author | Matrix TSL |
Version | 1.0 (Release) |
Category | Storage |
Contents
RTC (MCP7940N) component
Serial (I2C) Real Time Clock component for MCP7940N device. When used with a MIAC project this component gives access to the internal RTC (if fitted, depending upon model) and the component properties will be automatically configured.
Examples
No additional examples
Downloadable macro reference
SetTime
Sets the time from a string HHMMSS
Parameters
- <- STRING Time
- This parameter may be returned back to the caller
Return value
- This call does not return a value
GetTime
Returns the time as a string HHMMSS
Parameters
- This macro has no parameters
Return value
ReadRegister
Read and return the value of the RTC register at the given address
Parameters
- BYTE address
Return value
SetDate
Sets the date from a string DDMMYY
Parameters
- <- STRING Date
- This parameter may be returned back to the caller
Return value
- This call does not return a value
GetDate
Returns the date as a string DDMMYY
Parameters
- This macro has no parameters
Return value
WriteRegister
Write the given data value to the RTC register at the given address
Parameters
- BYTE address
- BYTE data
Return value
- This call does not return a value
Simulation macro reference
This component does not contain any simulation macros
Property reference
Channel
This property is of type Fixed list of ints and can be referenced with the variable name cal_i2c1::CHANNEL.
Channel selection
SDA
This property is of type Single digital pin and can be referenced with the variable name cal_i2c1::SDA.
Pin used for SDA (data signal)
SDA Remap Pin
This property is of type Fixed list of ints and can be referenced with the variable name cal_i2c1::SDAPins.
No additional information
SCL
This property is of type Single digital pin and can be referenced with the variable name cal_i2c1::SCL.
Pin used for SCL (clock signal)
SCL Remap Pin
This property is of type Fixed list of ints and can be referenced with the variable name cal_i2c1::SCLPins.
No additional information
Stop Delay
This property is of type True or false and can be referenced with the variable name cal_i2c1::StopDel.
On older microcontroller devices there is a potential for the I2C hardware channel to lock up if there is not
a 10ms delay between an I2C stop event and the next I2C start event.
Most modern microcontrollers will not have a problem so this property can be disabled to speed up the
I2C communications.
Baud Select
This property is of type Fixed list of ints and can be referenced with the variable name cal_i2c1::BAUD_LIST.
Baud rate option selector
Baud Rate
This property is of type Signed integer and can be referenced with the variable name cal_i2c1::BAUD.
Baud rate to be used
Scope Traces
This property is of type True or false and can be referenced with the variable name cal_i2c1::ScopeTraces.
Selects if the component pin connections are automatically generated on the data recorder window or not.
Yes: Automatically add the component pins to a group on the data recorder which will reflect the sim data during simultion.
No: Do not show the pin signals on the data recorder window.
Console Data
This property is of type True or false and can be referenced with the variable name cal_i2c1::ConsoleData.
Selects if the console data is automatically generated or not
Injector
This property is of type Fixed list of ints and can be referenced with the variable name cal_i2c1::Injector.
No additional information