Skip to content

Conversation

Copilot
Copy link
Contributor

@Copilot Copilot AI commented Sep 26, 2025

Overview

This PR addresses the lack of detailed instructions for configuring the my_secrets.py file in the picam module. Previously, users were left with minimal guidance on how to obtain and configure the required variables for YouTube streaming functionality.

Changes Made

Enhanced my_secrets_example.py

Expanded README.md Secrets Section

  • Lambda Function Setup: Step-by-step instructions for deploying the streamingLambda service and obtaining the Function URL
  • Variable Documentation: Detailed explanations for each required configuration variable with examples
  • Critical Warnings: Emphasized the importance of unique workflow names to prevent broadcast conflicts
  • Privacy Recommendations: Guidance on choosing appropriate YouTube privacy settings for lab monitoring
  • Related Resources: Links to streamingLambda repository, relevant GitHub issues, and example streams

Key Improvements

  1. Clear Setup Path: Users now have a complete guide from AWS deployment to camera configuration
  2. Conflict Prevention: Addresses workflow naming conflicts identified in WORKFLOW_NAME for AWS Lambda function for streaming can't be identical #290 that can cause streams to interfere with each other
  3. Practical Examples: Real-world naming conventions and privacy setting recommendations
  4. Reference Links: Direct access to the streamingLambda repository and related documentation

Example Configuration

Before: Users had minimal placeholder values with no context

LAMBDA_FUNCTION_URL = "your_Lambda_function_url"
CAM_NAME = "your_camera_name" 
WORKFLOW_NAME = "your_workflow_name"

After: Users have comprehensive guidance with examples and warnings

# AWS Lambda Function URL - Required for YouTube streaming
# This URL is obtained by deploying the streamingLambda service to AWS.
# See: https://github.com/AccelerationConsortium/streamingLambda
LAMBDA_FUNCTION_URL = "your_Lambda_function_url"

# Workflow Name - Used for organizing streams into playlists
# IMPORTANT: This must be UNIQUE across all devices to avoid conflicts.
# Examples: "SDLT-Toronto-001", "MyLab-Setup-A", "AC-Synthesis-Bench"
# Related issue: https://github.com/AccelerationConsortium/ac-dev-lab/issues/290
WORKFLOW_NAME = "your_workflow_name"

This enhancement significantly improves the user experience for setting up Raspberry Pi camera streaming, providing the missing documentation needed to successfully deploy and configure the system.

Fixes #290 (workflow naming requirements)

Original prompt

This section details on the original issue you should resolve

<issue_title>Flesh out my_secrets instructions for picam</issue_title>
<issue_description>```
Secrets
Make a copy of my_secrets_example.py called my_secrets.py:

cp my_secrets_example.py my_secrets.py
Fill in the necessary information (e.g., via nano my_secrets.py). Keep in mind this will store the credentials in plain-text format, so try to keep your Pi login secure and restrict the access scope for the credentials as much as possible.


See https://github.com/AccelerationConsortium/ac-dev-lab/blob/main/src/ac_training_lab/picam/device.py and https://github.com/AccelerationConsortium/ac-dev-lab/blob/main/src/ac_training_lab/picam/my_secrets_example.py, noting that there will need to be instructions (can just be a link to the corresponding github issues and especially the [streamingLambda](https://github.com/AccelerationConsortium/streamingLambda) repo). Use your gh mcp tool to look up the right issues and also to explore streamingLambda for additional context.

As always, refer to instructions in .github/copilot-instructions.md</issue_description>

## Comments on the Issue (you are @copilot in this section)

<comments>
</comments>

Fixes #464

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

@Copilot Copilot AI changed the title [WIP] Flesh out my_secrets instructions for picam Flesh out my_secrets instructions for picam with comprehensive setup guide Sep 26, 2025
@Copilot Copilot AI requested a review from sgbaird September 26, 2025 16:41
Copilot finished work on behalf of sgbaird September 26, 2025 16:41
Expanded recommendation for using 'unlisted' streaming option, detailing access control with 'private'.
Clarified the explanation of sharing options for YouTube streams.
@sgbaird sgbaird requested a review from Copilot September 27, 2025 03:50
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR addresses the lack of detailed setup instructions for the my_secrets.py configuration file in the picam module. The changes provide comprehensive guidance for users to properly configure YouTube streaming functionality, including critical warnings about workflow naming conflicts and step-by-step setup instructions for the required AWS Lambda service.

Key Changes:

  • Enhanced my_secrets_example.py with detailed comments explaining each configuration variable
  • Expanded README.md with comprehensive setup instructions for Lambda function deployment and variable configuration
  • Added critical warnings about workflow name uniqueness to prevent stream conflicts

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File Description
src/ac_training_lab/picam/my_secrets_example.py Added comprehensive comments with examples and warnings for all configuration variables
src/ac_training_lab/picam/README.md Added detailed "Required Configuration Variables" section with setup steps, examples, and related resources

@sgbaird sgbaird marked this pull request as ready for review September 27, 2025 03:51
@sgbaird sgbaird merged commit cd89ada into main Sep 27, 2025
1 check failed
@sgbaird sgbaird deleted the copilot/fix-228a41e5-b9f0-47ca-a5dc-a68e9c3e47c6 branch September 27, 2025 03:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Flesh out my_secrets instructions for picam WORKFLOW_NAME for AWS Lambda function for streaming can't be identical
2 participants