Skip to content

Commit

Permalink
update example
Browse files Browse the repository at this point in the history
  • Loading branch information
george committed Oct 20, 2023
1 parent 5bb9025 commit 2ea56f9
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 8 deletions.
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ crystal = 25e6 # crystal frequency
mult = 15 # 15 * 25e6 = 375 MHz PLL frequency
freq = 3.0e6 # output frequency, upper limit 200MHz
quadrature = True # lower limit for quadrature is 375MHz / 128
invert = False # invert has no effect in quadrature mode
# invert = True
invert = False # invert option is ignored in quadrature mode
# invert, quadrature = True, False

si = SI5351_I2C(i2c, crystal=crystal)
si.init_clock(output=0, pll=0)
Expand All @@ -56,8 +56,7 @@ This is required in order to generate quadrature
output. But it is also required to synchronize all outputs
derived off a particular PLL, so all such derived outputs
are coherrent, like inverted outputs. This can be demonstrated
by uncommenting the statement above with invert=True and commenting out
the statement with quadrature=quadrature.
by uncommenting the statement with "invert, quadrature = True, False".

## API

Expand Down
4 changes: 2 additions & 2 deletions example.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@
mult = 15 # 15 * 25e6 = 375 MHz PLL frequency
freq = 3.0e6 # output frequency, upper limit 200MHz
quadrature = True # lower limit for quadrature is 375MHz / 128
invert = False # invert has no effect in quadrature mode
# invert = True
invert = False # invert option is ignored in quadrature mode
# invert, quadrature = True, False

si = SI5351_I2C(i2c, crystal=crystal)
si.init_clock(output=0, pll=0)
Expand Down
3 changes: 1 addition & 2 deletions res/readme.py
Original file line number Diff line number Diff line change
Expand Up @@ -86,8 +86,7 @@ def generate_docs(package, data=None, classname=None, text=[]):
output. But it is also required to synchronize all outputs
derived off a particular PLL, so all such derived outputs
are coherrent, like inverted outputs. This can be demonstrated
by uncommenting the statement above with invert=True and commenting out
the statement with quadrature=quadrature.
by uncommenting the statement with "invert, quadrature = True, False".
## API
Expand Down

0 comments on commit 2ea56f9

Please sign in to comment.