• AVR Freaks

Hot!Harmony 3.x documentation?

Author
RodoPIC
Senior Member
  • Total Posts : 180
  • Reward points : 0
  • Status: offline
2019/08/20 13:30:24 (permalink)
0

Harmony 3.x documentation?

Hi all,
I installed harmony 3.4 and I see there are folders named "Docs" with HTML and .chm files in the framework destination folder.  Is clicking on the files the only way to access the documentation for harmony 3.x? 
Thanks
#1

3 Replies Related Threads

    mjolhe01
    Starting Member
    • Total Posts : 5
    • Reward points : 0
    • Joined: 2019/08/28 08:00:56
    • Location: 0
    • Status: offline
    Re: Harmony 3.x documentation? 2019/09/20 10:10:33 (permalink)
    0
    Not sure if this is what you are looking for, but here is what I ran into when I first got into Harmony 3. This was my first attempt to use Harmony of any sort, so this might be obvious to others with experience with similar structure.  It was not intuitive to me for whatever reason. Seems like some help files are easy to navigate to and others are not. 
     
    For graphics I more or less stumbled into the help files here:
    https://microchip-mplab-harmony.github.io/gfx
     
    When I was looking for help with timers, I knew it was in the core section so I just replaced the 'gfx' with 'core'
    https://microchip-mplab-harmony.github.io/core
     
    It looks like you can just replace the name at the end for the relevant topic (or leave it blank for the main page).
     
    In some cases you can go to the harmony main web page and navigate to the help pages quickly. For instance with Motor Control, you can just go to the main page, scroll down to the motor control page, and there is a link in the wiki that says 'MPLAB Harmony 3 Motor Control Help'
    https://www.microchip.com/mplab/mplab-harmony
    https://github.com/Microchip-MPLAB-Harmony/motor_control/wiki
    https://microchip-mplab-harmony.github.io/motor_control/
     
    #2
    JPortici
    Super Member
    • Total Posts : 771
    • Reward points : 0
    • Joined: 2012/11/17 06:27:45
    • Location: Grappaland
    • Status: offline
    Re: Harmony 3.x documentation? 2019/09/21 12:12:31 (permalink)
    0
    the documentation you see on the CHM files is the exact copy on the one on github.
     
    As github is awesome, if you find errors or that it lacks information, you can suggest changes :D
    #3
    Tom Crosley
    New Member
    • Total Posts : 20
    • Reward points : 0
    • Joined: 2016/07/26 15:56:24
    • Location: Microchip Technology
    • Status: offline
    Re: Harmony 3.x documentation? 2019/10/09 15:38:01 (permalink)
    0
    In the doc folder in each repo that you have downloaded, there should be a .chm (compiled help) file and a .pdf file.  Double-click on either one for help for that repo.  (The gfx repo only has a .chm, the .pdf became too big.)
    In the docs folder, there are hundreds of .html files.  You want to double-click on index.html to start at the top level.
    In all three cases, the documentation is actually the same, just choose the format you prefer.
     
    The online GitHub page for Harmony 3 ( https://github.com/microchip-mplab-harmony)  has links to each repo.  If you navigate to one of the repos, you will see the same files I already mentioned.  However along the top, just below the name of the repo, are a bunch of tabs: Code, Issues, …  Click on Wiki and you will be taken to the wiki for that repo.  There you will find a lot more documentation that is not part of the downloaded repo, typically including tutorials and get started guides.
    #4
    Jump to:
    © 2019 APG vNext Commercial Version 4.5