Clockstudio-Software-Users-Guide
Clockstudio-Software-Users-Guide
Clockstudio-Software-Users-Guide
User’s Guide
• Microchip believes that its family of products is secure when used in the intended manner, within operating specifications, and
under normal conditions.
• Microchip values and aggressively protects its intellectual property rights. Attempts to breach the code protection features of
Microchip product is strictly prohibited and may violate the Digital Millennium Copyright Act.
• Neither Microchip nor any other semiconductor manufacturer can guarantee the security of its code. Code protection does not
mean that we are guaranteeing the product is "unbreakable" Code protection is constantly evolving. Microchip is committed to
continuously improving the code protection features of our products.
This publication and the information herein may be used only Trademarks
with Microchip products, including to design, test, and integrate The Microchip name and logo, the Microchip logo, Adaptec, AVR, AVR
Microchip products with your application. Use of this informa- logo, AVR Freaks, BesTime, BitCloud, CryptoMemory, CryptoRF,
tion in any other manner violates these terms. Information dsPIC, flexPWR, HELDO, IGLOO, JukeBlox, KeeLoq, Kleer,
regarding device applications is provided only for your conve- LANCheck, LinkMD, maXStylus, maXTouch, MediaLB, megaAVR,
nience and may be superseded by updates. It is your responsi- Microsemi, Microsemi logo, MOST, MOST logo, MPLAB, OptoLyzer,
PIC, picoPower, PICSTART, PIC32 logo, PolarFire, Prochip Designer,
bility to ensure that your application meets with your
QTouch, SAM-BA, SenGenuity, SpyNIC, SST, SST Logo, SuperFlash,
specifications. Contact your local Microchip sales office for Symmetricom, SyncServer, Tachyon, TimeSource, tinyAVR, UNI/O,
additional support or, obtain additional support at https:// Vectron, and XMEGA are registered trademarks of Microchip
www.microchip.com/en-us/support/design-help/client-support- Technology Incorporated in the U.S.A. and other countries.
services.
AgileSwitch, ClockWorks, The Embedded Control Solutions
THIS INFORMATION IS PROVIDED BY MICROCHIP "AS IS". Company, EtherSynch, Flashtec, Hyper Speed Control, HyperLight
MICROCHIP MAKES NO REPRESENTATIONS OR WAR- Load, Libero, motorBench, mTouch, Powermite 3, Precision Edge,
RANTIES OF ANY KIND WHETHER EXPRESS OR IMPLIED, ProASIC, ProASIC Plus, ProASIC Plus logo, Quiet-Wire,
SmartFusion, SyncWorld, TimeCesium, TimeHub, TimePictra,
WRITTEN OR ORAL, STATUTORY OR OTHERWISE,
TimeProvider, and ZL are registered trademarks of Microchip
RELATED TO THE INFORMATION INCLUDING BUT NOT Technology Incorporated in the U.S.A.
LIMITED TO ANY IMPLIED WARRANTIES OF NON-
INFRINGEMENT, MERCHANTABILITY, AND FITNESS FOR A Adjacent Key Suppression, AKS, Analog-for-the-Digital Age, Any
PARTICULAR PURPOSE, OR WARRANTIES RELATED TO Capacitor, AnyIn, AnyOut, Augmented Switching, BlueSky,
ITS CONDITION, QUALITY, OR PERFORMANCE. BodyCom, Clockstudio, CodeGuard, CryptoAuthentication,
CryptoAutomotive, CryptoCompanion, CryptoController, dsPICDEM,
IN NO EVENT WILL MICROCHIP BE LIABLE FOR ANY INDI- dsPICDEM.net, Dynamic Average Matching, DAM, ECAN, Espresso
RECT, SPECIAL, PUNITIVE, INCIDENTAL, OR CONSE- T1S, EtherGREEN, EyeOpen, GridTime, IdealBridge, IGaT, In-Circuit
Serial Programming, ICSP, INICnet, Intelligent Paralleling, IntelliMOS,
QUENTIAL LOSS, DAMAGE, COST, OR EXPENSE OF ANY
Inter-Chip Connectivity, JitterBlocker, Knob-on-Display, MarginLink,
KIND WHATSOEVER RELATED TO THE INFORMATION OR maxCrypto, maxView, memBrain, Mindi, MiWi, MPASM, MPF, MPLAB
ITS USE, HOWEVER CAUSED, EVEN IF MICROCHIP HAS Certified logo, MPLIB, MPLINK, mSiC, MultiTRAK, NetDetach,
BEEN ADVISED OF THE POSSIBILITY OR THE DAMAGES Omniscient Code Generation, PICDEM, PICDEM.net, PICkit, PICtail,
ARE FORESEEABLE. TO THE FULLEST EXTENT Power MOS IV, Power MOS 7, PowerSmart, PureSilicon, QMatrix,
ALLOWED BY LAW, MICROCHIP'S TOTAL LIABILITY ON REAL ICE, Ripple Blocker, RTAX, RTG4, SAM-ICE, Serial
ALL CLAIMS IN ANY WAY RELATED TO THE INFORMATION Quad I/O, simpleMAP, SimpliPHY, SmartBuffer, SmartHLS, SMART-
I.S., storClad, SQI, SuperSwitcher, SuperSwitcher II, Switchtec,
OR ITS USE WILL NOT EXCEED THE AMOUNT OF FEES, IF
SynchroPHY, Total Endurance, Trusted Time, TSHARC, Turing,
ANY, THAT YOU HAVE PAID DIRECTLY TO MICROCHIP USBCheck, VariSense, VectorBlox, VeriPHY, ViewSpan, WiperLock,
FOR THE INFORMATION. XpressConnect, and ZENA are trademarks of Microchip Technology
Incorporated in the U.S.A. and other countries.
Use of Microchip devices in life support and/or safety applica-
tions is entirely at the buyer's risk, and the buyer agrees to SQTP is a service mark of Microchip Technology Incorporated in the
defend, indemnify and hold harmless Microchip from any and U.S.A.
all damages, claims, suits, or expenses resulting from such
use. No licenses are conveyed, implicitly or otherwise, under The Adaptec logo, Frequency on Demand, Silicon Storage
Technology, and Symmcom are registered trademarks of Microchip
any Microchip intellectual property rights unless otherwise
Technology Inc. in other countries.
stated.
GestIC is a registered trademark of Microchip Technology Germany II
GmbH & Co. KG, a subsidiary of Microchip Technology Inc., in other
countries.
NOTICE TO CUSTOMERS
All documentation becomes dated, and this manual is no exception. Microchip tools and
documentation are constantly evolving to meet customer needs, so some actual dialogs
and/or tool descriptions may differ from those in this document. Please refer to our website
(www.microchip.com) to obtain the latest documentation available.
Documents are identified with a “DS” number. This number is located on the bottom of each
page, in front of the page number. The numbering convention for the DS number is
“DSXXXXXXXXA”, where “XXXXXXXX” is the document number and “A” is the revision level
of the document.
For the most up-to-date information on development tools, see the MPLAB® IDE online help.
Select the Help menu, and then Topics, to open a list of available online help files.
DOCUMENTATION CONVENTIONS
Description Represents Examples
Arial font:
Italic characters Referenced books MPLAB® IDE User’s Guide
Emphasized text ...is the only compiler...
Initial caps A window the Output window
A dialog the Settings dialog
A menu selection select Enable Programmer
All caps An operating mode, alarm ALARM
state, status, or chassis label
Quotes A field name in a window or “Save project before build”
dialog
Underlined, italic text with A menu path File>Save
right angle bracket
Bold characters A dialog button Click OK
A tab Click the Power tab
N‘Rnnnn A number in verilog format, 4‘b0010, 2‘hF1
where N is the total number of
digits, R is the radix and n is a
digit.
Text in angle brackets < > A key on the keyboard Press <Enter>, <F1>
WARNING
To avoid serious personal injury or death, do not disregard warnings. All warnings use
this style. Warnings are installation, operation, or maintenance procedures, practices,
or statements, that if not strictly observed, may result in serious personal injury or even
death.
CAUTION
To avoid personal injury, do not disregard cautions. All cautions use this style. Cau-
tions are installation, operation, or maintenance procedures, practices, conditions, or
statements, that if not strictly observed, may result in damage to, or destruction of, the
equipment. Cautions are also used to indicate a long-term health hazard.
Note: All notes use this style. Notes contain installation, operation, or mainte-
nance procedures, practices, conditions, or statements that alert you to
important information, which may make your task easier or increase your
understanding.
Table of Contents
Preface
Conventions Used in this Guide ............................................................................ 3
Warnings, Cautions, Recommendations, and Notes............................................. 4
Where to Find Answers to Product and Document Questions .............................. 5
Related Documents and Information..................................................................... 5
The Microchip Website .......................................................................................... 5
Customer Support ................................................................................................. 6
Document Revision History ................................................................................... 6
Chapter 1. Introduction
1.1 Product Description ......................................................................................... 9
1.2 Product Features............................................................................................. 9
1.3 Basic GUI Layout ............................................................................................ 9
Chapter 2. Operation
2.1 File Menu....................................................................................................... 11
2.1.1 Open Telemetry... (Ctrl+O)......................................................................... 11
2.1.2 Open Recent .............................................................................................. 11
2.1.3 Export Telemetry... ..................................................................................... 11
2.1.4 Rename Telemetry..................................................................................... 11
2.1.5 Quit ............................................................................................................. 12
2.2 Settings Menu ............................................................................................... 12
2.2.1 Preferences ................................................................................................ 12
2.3 Help Menu ..................................................................................................... 12
2.3.1 About Clockstudio... ................................................................................... 12
2.3.2 User Manual ............................................................................................... 12
2.4 Connect Tab.................................................................................................. 12
2.4.1 Serial Port................................................................................................... 12
2.4.2 TCP Host .................................................................................................... 12
2.5 Title Bar ......................................................................................................... 12
2.5.1 Disconnect/Reconnect Button .................................................................... 13
2.5.2 Device Product Name ................................................................................ 13
2.5.3 “Serial”........................................................................................................ 13
2.5.4 Port “Address” ............................................................................................ 13
2.5.6 Data Polling Rate ....................................................................................... 13
2.6 Toolbars ........................................................................................................ 13
2.6.1 Common Tools ........................................................................................... 13
2.6.1.1 Device Info Tool.......................................................................... 13
2.6.1.2 Device Telemetry Tool................................................................ 14
2.6.1.3 Upgrade Firmware Tool.............................................................. 15
2.6.1.4 Notes Tool .................................................................................. 16
2.6.2 CSAC Tools................................................................................................ 17
Chapter 2. Operation
A user primarily interacts with the application via mouse (such as selecting from
drop-down menus and toggling radio buttons) and secondarily with the keyboard (to set
device-specific parameters or enter commands via the console feature, for example).
The application was designed to run on Windows 10 and 11 based systems.
This User Guide divides the GUI in to eight main features, described in the following
sections:
• File menu: describes file loading and saving
• Settings menu: lists modifiable Clockstudio™ application settings
• About menu: contains general Clockstudio software version information
• Start tab: initiate communication with a device, open a file, or link to a product sup-
port URL
• Title bar: overview of the connected device
• Toolbar: lists available interactive features of a device
• Status bar: contains the console along with active data file information
• Charting: description of how to plot telemetry parameters
2.1.5 Quit
Exits the Clockstudio application.
2.2.1 Preferences
The Preferences tab allows a user to adjust the telemetry capture settings. Default set-
tings can be adjusted, including the location for storing data files, file naming conven-
tion, and the polling rate.
Visual display settings can also be adjusted, including chart density (resolution).
2.5.3 “Serial”
The device serial number is specific to each individual device and is read directly from
the device’s own saved “serial number” parameter.
2.6 TOOLBARS
2.6.1 Common Tools
This section describes the tools in the Toolbar that are supported among all device
types:
• Device Info Tool
• Telemetry Tool
• Firmware Upgrade Tool (supported devices only, connection required)
• Notes Tool
Most of these tools are available when opening a data file from disk and when con-
nected to a live device.
CAUTION
If the transfer is interrupted, the device will not function properly until firmware is
reloaded with a subsequent attempt. Reconnecting to the device will show “bsl” as the
device’s application on the Device Info Tool and telemetry will not be available.