Starcamera - first PR request for testing starcamera at the LAT #335

karenperezsarmiento · 2022-08-01T21:08:39Z

Description

The latest version of the starcamera agent is able to connect to the device, receive telemetry/astrometry data and save it to the correct registries.

Motivation and Context

Agent is capable to connecting to device and receiving telemetry data.

How Has This Been Tested?

The agent has been tested with the starcamera system connected but dark (test run not done on real sky).

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)

Checklist:

My code follows the code style of this project.
My change requires a change to the documentation.
I have updated the documentation accordingly.
Unless I am preparing a release, I have opened this PR onto the develop branch.

sanahabhimani

Thanks for the PR, Karen! Sorry it took us a while to get back to you; since your initial request, we've restructured socs so PR's are now made to merge into main instead of develop.

I changed a lot of the key structure of your star camera agent branch to make it compatible with the updated socs. This way, the comments are more related to the agent itself. As a result, when you go to make updates to this agent, be sure to pull from the starcamera branch first to make sure you have the up-to-date version of this branch.

A couple notes were made on the extra files pushed to the branch.

One major note that isn't present in the comments below: you'll also need to write documentation for your agent so that it's available to see on the socs readthedocs page.

socs/agents/starcam/agent.py

BrianJKoopman

Yes, thanks @karenperezsarmiento! And thanks @sanahabhimani for the thorough review!

I've commented on some points that Sanah brought up, and also have a structural question about the way the task and process interact to command the starcamera.

socs/agents/starcam/agent.py

…ocs/socs/agents/starcam_lat in agent.py: - changed class names from starcam_Helper and starcam_Agent to StarcamHelper and StarcamAgent - combined pack_cmds() and send_cmds() into single function: pack_and_send_cmds() - in pack_and_send_cmds(), added all values to a list (named values) packed and sent said commands added a return values - in get_astrom_data(), added a list of keys for a dictionary made dictionary from unpacked data added a return for this dictionary - in acq(), replace dictionary definition given the changes to get_astrom_data() changed job = 'init' to job = 'acq' - in add_agent_args() removed defult ip address changed --user-port to --port change all instances of parser_in to parser moved import statement to top of file - in main() removed startup=True added txaio commands for logging and import txaio at top of file - changed doc strings across file - insterted ocs param decorator above send_commands() - changed latitude, longitude, and height params in send_commands() to reflect chilean coords

for more information, see https://pre-commit.ci

- reduced line lengths to satisfy pep8 rules -- some variable names were adjusted to accomodate this change

…tarcamera changes: - reduced line lengths to satisfy pep8 rules -- some variable names changed to accomodate this change

for more information, see https://pre-commit.ci

- changed invalid character in print statement to pass flake8 check

BrianJKoopman

Hi @AlexManduca, sorry I haven't had a chance to review your recent changes in detail yet, but there are a couple of things to address first anyway. In addition to the comment below the pre-commit checks are failing due to invalid characters in the code, see details here: https://results.pre-commit.ci/run/github/186511668/1732120479.uB-orrk5RL2nfbGl2oGNXg

(This link is linked at the bottom of the PR if you click "details" next to "pre-commit.ci - pr" in the checks section.)

socs/agents/starcam_lat/agent.py

…tarcamera

- fixed invalid character to pass pre-commit check - resolved merge conflict - changed a couple variable names that were wrong before

- added import for os environ

for more information, see https://pre-commit.ci

- corrected typo in import - deleted 'LOG =' for txaio logging in main since LOG is never used

BrianJKoopman

This is looking good, thanks @AlexManduca. A few more comments to address below.

Another general comment is we need a page for this agent in the documentation. That will live in socs/docs/agents/. A template for this page can be found in the ocs docs. Feel free to reference any of the existing pages too. Once you create a page, please add it to the index here as well.

socs/agents/starcam_lat/agent.py

socs/agents/starcam/agent.py

socs/agents/starcam_lat/agent.py

socs/agents/starcam/agent.py

BrianJKoopman · 2025-01-08T05:10:25Z

socs/agents/starcam_lat/agent.py

+        try:
+            self.StarcamHelper = StarcamHelper(ip_address, port)
+        except socket.timeout:
+            self.log.error("Starcamera connection has times out")
+            return False, "Timeout"


It would still be useful to separate this part into an init operation that can be called from an ocs client (as hinted at in #335 (comment).) That would allow users to re-initialize the connection to the star camera without needing to completely restart the agent. That structure is in many of the other agents, one good example is the CryomechAgent:

socs/socs/agents/cryomech_cpa/agent.py

Lines 50 to 91 in 9242ab2

@ocs_agent.param('auto_acquire', default=False, type=bool)

def init(self, session, params=None):

"""init(auto_acquire=False)

**Task** - Initializes the connection to the PTC.

Parameters:

auto_acquire (bool): Automatically start acq process after

initialization if True. Defaults to False.

"""

if self.initialized:

return True, "Already Initialized"

with self.lock.acquire_timeout(0, job='init') as acquired:

if not acquired:

self.log.warn("Could not start init because "

"{} is already running".format(self.lock.job))

return False, "Could not acquire lock."

# Establish connection to ptc

self.ptc = PTC(self.ip_address, port=self.port,

fake_errors=self.fake_errors)

# Test connection and display identifying info

try:

self.ptc.get_data()

except ConnectionError:

self.log.error("Could not establish connection to compressor.")

return False, "PTC agent initialization failed"

print("PTC Model:", self.ptc.model)

print("PTC Serial Number:", self.ptc.serial)

print("Software Revision is:", self.ptc.software_revision)

self.initialized = True

# Start data acquisition if requested

if params['auto_acquire']:

resp = self.agent.start('acq', params={})

self.log.info(f'Response from acq.start(): {resp[1]}')

return True, "PTC agent initialized"

I'd be happy to help with this, and to simultaneously set this up to use the new TCPInterface base class for the TCP connection to the star camera, as that will help make the agent robust against network issues.

I see, so that would mean there would be e.g. an "init" button on ocs-web. Cool! And added robustness for TCP connection would be great, the connection does tend to drop pretty frequently.

Thanks for offering that, let me know how best to proceed!

Thanks for offering that, let me know how best to proceed!

Just let me know when you're done making changes.

socs/agents/starcam_lat/agent.py

Docstrings are now consistently formatted according to the 'Example Google Style Python Docstrings' document found at the following URL: https://sphinxcontrib-napoleon.readthedocs.io/en/latest/ex ample_google.html#example-google Several different ways of writing "starcam" (e.g. "starcamera", "star camera", etc.) made references to the instrument name inconsistent. All instances have been changed to a succinct "starcam". One or two typos were also fixed, and periods were added where appropriate. Resolves:

The buffer size had been set to an unusual 224. It is now set to 256.

- In StarcamAgent’s __init__(), self.active = True and self.job = None are leftover from the agent this one was based on. - In acq(), if params is None: params = {} is not necessary. - In _stop_acq(), the comment should be removed as we currently have no way to re-establish connection without restarting the agent.

Attribute names changed from Pascal case to snake case. e.g. self.StarcamHelper --> self.starcam

Docstrings: The docstrings for Tasks in this agent were not correctly formatted. They have been adjusted to accomodate the standards set forth in the following document: https://ocs.readthedocs.io/en/main/developer/agent_references/ documentation.html#session-data Accompanying this reformatting, the session.data object structure was documented in the acq() docstring. Timeout: The timeout for acquiring a lock was set to 100s. This has been changed to 10s. Typo: The self.log.warn String was changed from “Could not start init because {} is already running” to “Could not start acq because {} is already running”.

for more information, see https://pre-commit.ci

The 'Returns:' sections were removed from the acq() and the send_commands() agent operation docstrings.

…tarcamera

for more information, see https://pre-commit.ci

Edited docstrings to be more consistent with other agents' docstrings. Nothing outside of docstrings was touched.

…tarcamera

for more information, see https://pre-commit.ci

BrianJKoopman

Thanks for all the changes @AlexManduca, this is looking good. I made some small commits, including adding a docs page. Would you mind filling out the sections that have text starting with '#' -- the brief description, any dependencies, and more detailed description of the agent/hardware it controls in this file?

Besides that all that's left is for me to implement that 'init' task with TCP connection handling that I said I'd implement. I should be able to get that done by end of day tomorrow, then we'll just want to test things work alright. Is the star camera in a state where we can do that?

BrianJKoopman self-requested a review August 2, 2022 18:23

BrianJKoopman assigned karenperezsarmiento Aug 2, 2022

BrianJKoopman added the new agent New OCS agent needs to be created label Aug 2, 2022

BrianJKoopman requested a review from sanahabhimani May 22, 2023 15:42

sanahabhimani changed the base branch from develop to main May 25, 2023 17:30

sanahabhimani requested changes May 26, 2023

View reviewed changes

BrianJKoopman reviewed Jun 8, 2023

View reviewed changes

socs/agents/starcam/agent.py Outdated Show resolved Hide resolved

socs/agents/starcam/agent.py Outdated Show resolved Hide resolved

socs/agents/starcam/agent.py Outdated Show resolved Hide resolved

socs/agents/starcam/agent.py Outdated Show resolved Hide resolved

BrianJKoopman assigned AlexManduca and unassigned karenperezsarmiento Aug 27, 2024

AlexManduca force-pushed the starcamera branch from 001a752 to 3fc8d8b Compare November 13, 2024 19:23

pre-commit-ci bot and others added 5 commits November 13, 2024 19:23

[pre-commit.ci] auto fixes from pre-commit.com hooks

82252e7

for more information, see https://pre-commit.ci

changes:

f7a0565

- reduced line lengths to satisfy pep8 rules -- some variable names were adjusted to accomodate this change

Merge branch 'starcamera' of https://github.com/simonsobs/socs into s…

04999b4

…tarcamera changes: - reduced line lengths to satisfy pep8 rules -- some variable names changed to accomodate this change

[pre-commit.ci] auto fixes from pre-commit.com hooks

735850d

for more information, see https://pre-commit.ci

changes

0733d7a

- changed invalid character in print statement to pass flake8 check

BrianJKoopman requested changes Nov 20, 2024

View reviewed changes

socs/agents/starcam_lat/agent.py Outdated Show resolved Hide resolved

tanaybhandarkar and others added 5 commits November 20, 2024 16:07

Merge branch 'starcamera' of https://github.com/simonsobs/socs into s…

3ea0cce

…tarcamera

changes:

6465c4f

- fixed invalid character to pass pre-commit check - resolved merge conflict - changed a couple variable names that were wrong before

changes:

10db58a

- added import for os environ

[pre-commit.ci] auto fixes from pre-commit.com hooks

824305f

for more information, see https://pre-commit.ci

changes:

d2ca913

- corrected typo in import - deleted 'LOG =' for txaio logging in main since LOG is never used

BrianJKoopman self-requested a review January 8, 2025 03:09

BrianJKoopman requested changes Jan 8, 2025

View reviewed changes

AlexManduca and others added 6 commits January 15, 2025 18:36

Change buffer size in get_astrom_data

a5a2f24

The buffer size had been set to an unusual 224. It is now set to 256.

Change attribute names

fe0c275

Attribute names changed from Pascal case to snake case. e.g. self.StarcamHelper --> self.starcam

[pre-commit.ci] auto fixes from pre-commit.com hooks

34bfdfc

for more information, see https://pre-commit.ci

AlexManduca and others added 6 commits February 12, 2025 15:38

Remove Returns: sections from agent operation dosctrings

e198836

The 'Returns:' sections were removed from the acq() and the send_commands() agent operation docstrings.

Merge branch 'starcamera' of https://github.com/simonsobs/socs into s…

21cc75d

…tarcamera

[pre-commit.ci] auto fixes from pre-commit.com hooks

6d33d24

for more information, see https://pre-commit.ci

Touch up Docstrings

f2a9456

Edited docstrings to be more consistent with other agents' docstrings. Nothing outside of docstrings was touched.

Merge branch 'starcamera' of https://github.com/simonsobs/socs into s…

90bbfa9

…tarcamera

[pre-commit.ci] auto fixes from pre-commit.com hooks

267a02c

for more information, see https://pre-commit.ci

AlexManduca requested a review from BrianJKoopman February 14, 2025 19:58

BrianJKoopman added 5 commits May 6, 2025 17:06

Fix typo

e789b4a

Add agent to plugin list

26988c5

Create docs page for starcam agent

7b5bc3a

Clean up documentation

f4fca40

Merge branch 'main' into starcamera

f566702

BrianJKoopman reviewed May 6, 2025

View reviewed changes

BrianJKoopman mentioned this pull request May 7, 2025

Use TCPInterface class as base class for StarcamHelper #869

Open

6 tasks

	@ocs_agent.param('auto_acquire', default=False, type=bool)
	def init(self, session, params=None):
	"""init(auto_acquire=False)

	Task - Initializes the connection to the PTC.

	Parameters:
	auto_acquire (bool): Automatically start acq process after
	initialization if True. Defaults to False.

	"""
	if self.initialized:
	return True, "Already Initialized"

	with self.lock.acquire_timeout(0, job='init') as acquired:
	if not acquired:
	self.log.warn("Could not start init because "
	"{} is already running".format(self.lock.job))
	return False, "Could not acquire lock."

	# Establish connection to ptc
	self.ptc = PTC(self.ip_address, port=self.port,
	fake_errors=self.fake_errors)

	# Test connection and display identifying info
	try:
	self.ptc.get_data()
	except ConnectionError:
	self.log.error("Could not establish connection to compressor.")
	return False, "PTC agent initialization failed"
	print("PTC Model:", self.ptc.model)
	print("PTC Serial Number:", self.ptc.serial)
	print("Software Revision is:", self.ptc.software_revision)

	self.initialized = True

	# Start data acquisition if requested
	if params['auto_acquire']:
	resp = self.agent.start('acq', params={})
	self.log.info(f'Response from acq.start(): {resp[1]}')

	return True, "PTC agent initialized"

Starcamera - first PR request for testing starcamera at the LAT #335

Are you sure you want to change the base?

Starcamera - first PR request for testing starcamera at the LAT #335

Uh oh!

Conversation

karenperezsarmiento commented Aug 1, 2022 • edited by BrianJKoopman Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Motivation and Context

How Has This Been Tested?

Types of changes

Checklist:

Uh oh!

sanahabhimani left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

BrianJKoopman left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

BrianJKoopman left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

BrianJKoopman left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

BrianJKoopman Jan 8, 2025

Choose a reason for hiding this comment

Uh oh!

AlexManduca Feb 12, 2025

Choose a reason for hiding this comment

Uh oh!

BrianJKoopman Feb 13, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

BrianJKoopman left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

karenperezsarmiento commented Aug 1, 2022 •

edited by BrianJKoopman

Loading