# Suggested updates to API reference

**URL:** <https://forum.liquidinstruments.com/t/suggested-updates-to-api-reference/1035>\
**Category:** Software & APIs\
**Created:** [September 7, 2024, 2:21pm UTC](https://forum.liquidinstruments.com/t/suggested-updates-to-api-reference/1035 "2024-09-07T14:21:42Z")\
**Posts on this page:** 4\
**Page:** 1

<div class="post-metadata">

**Author:** ![todd](https://avatars.discourse-cdn.com/v4/letter/t/fbc32d/32.png) [@todd](https://forum.liquidinstruments.com/u/todd)\
**Post date:** [September 7, 2024, 2:21pm UTC](https://forum.liquidinstruments.com/t/suggested-updates-to-api-reference/1035/1 "2024-09-07T14:21:42Z")

</div>

I am a prolific user of the Moku Python API, and have probably used every function in the book so far! I just came across a few minor errors in the API reference documentation ([apis.liquidinstruments.com](http://apis.liquidinstruments.com)) that I’ve accumulated, which could be easily fixed and might help future users:

- The landing page ([https://apis.liquidinstruments.com/reference/](https://apis.liquidinstruments.com/reference/)) has a textbox stating “This library only supports interactions with Moku:Go and Moku:Pro. To command or control Moku:Lab please visit …” but I believe this is outdated information, with Moku:Labs using the same API as Pro and Go since 3.0.0.

- laser\_lock\_box.set\_output\_limit.low\_limit: has a listed default value of “nullptr” which is C++

- laser\_lock\_box.set\_scan\_oscillator: keyword for amplitude of the auxillary oscillator is labelled as “frequency”

- laser\_lock\_box.set\_filter.order: no allowed values listed, labelled as “required” despite not being set in example code, type “number” should probably be type “integer”. Same issues in digital\_filter\_box.set\_filter.order

- laser\_lock\_box:set\_monitor:monitor\_channel has no list of allowed values.

- phasemeter:enable\_freewheeling: request additional information on function. Not clear from the instrument documentation.

- phasemeter:get\_data is the entire function deprecated, or just the two listed parameters? Unclear.

- phasemeter:set\_pm\_loop:bandwidth, type listed as “number”, should be “string”; “units” unnecessary

In addition, I’m suddenly unable to set the slow control PID controller using “set\_pid\_by\_frequency” function of the laser\_lock\_box: every attempt returns “Invalid Method” error despite having worked in this exact form a few weeks ago.

Cheers, and thanks for all the updates and improvements!

---

<div class="post-metadata">

**Author:** ![indira](https://yyz1.discourse-cdn.com/flex035/user_avatar/forum.liquidinstruments.com/indira/32/317_2.png) [@indira](https://forum.liquidinstruments.com/u/indira)\
**Post date:** [September 9, 2024, 1:51am UTC](https://forum.liquidinstruments.com/t/suggested-updates-to-api-reference/1035/2 "2024-09-09T01:51:35Z")

</div>

Hi Todd,

Thank you for your attentive API documentation fixes, I’ll update these in the API Reference. These changes will come out alongside a more significant update of the API Reference documentation, so you’ll probably see these published in the next month or so.

Thanks again,  
Indira

---

<div class="post-metadata">

**Author:** ![indira](https://yyz1.discourse-cdn.com/flex035/user_avatar/forum.liquidinstruments.com/indira/32/317_2.png) [@indira](https://forum.liquidinstruments.com/u/indira)\
**Post date:** [September 18, 2024, 2:16am UTC](https://forum.liquidinstruments.com/t/suggested-updates-to-api-reference/1035/3 "2024-09-18T02:16:59Z")

</div>

Hey @todd,

I’ve found a work around for the set\_pid\_by\_frequency issue that you can use to set the slow controller. You can set the slow controller in the Laser Lock Box using the App and then use `persist_state` when connecting to the device over the API to keep the slow controller settings that you set in the App.

In Python this is `i = LaserLockBox('10.1.XXX.XXX', persist_state=True)`

Sorry that this isn’t working right now but the dev team is working to fix function at the moment. You can find more information about persist\_state here: [https://apis.liquidinstruments.com/reference/moku/claim\_ownership.html#param-persist\_state](https://apis.liquidinstruments.com/reference/moku/claim_ownership.html#param-persist_state)

I hope this helps,  
Indira

---

<div class="post-metadata">

**Author:** ![todd](https://avatars.discourse-cdn.com/v4/letter/t/fbc32d/32.png) [@todd](https://forum.liquidinstruments.com/u/todd)\
**Post date:** [October 29, 2024, 1:24pm UTC](https://forum.liquidinstruments.com/t/suggested-updates-to-api-reference/1035/4 "2024-10-29T13:24:48Z")

</div>

The slow controller setting bug has been resolved as of 3.3.1.1 (firmware 600) and working again.