Script Request Guidelines

[Dimitar]

Script Request Guidelines

 

1. Provide a Clear Description:

• Clearly explain the functionality and purpose of the script you need.

• Include the use case or scenario where the script will be applied.

2. Identify the Target Device(s):

• Specify the Shelly device(s) for which the script is intended (e.g., Shelly 1PM, Shelly Pro 3EM, etc.).

• Mention firmware versions if relevant.

3. Detail Required Inputs and Outputs:

• List any input parameters the script will handle (e.g., temperature, power levels, sensor data).

• Specify the expected outputs (e.g., actions, status updates, data logs).

4. 3rd-Party Protocols or APIs (If Applicable):

• If your script involves integrating with a 3rd-party protocol or system, you must:

• Upload the required protocol documentation or API reference.

• Provide a direct link to the API documentation, if available.

• Note: The Shelly team cannot assist without this information.

5. Specify Required Features:

• Highlight specific features or actions you need, such as:

• Scheduling

• Communication with external systems

• Security measures (e.g., encryption)

6. Mention Any Constraints or Limitations:

• Indicate any known constraints (e.g., limited bandwidth, specific operating times).

• Include device limitations, if applicable.

7. Provide Any Existing Code or Examples (Optional):

• Share any existing scripts, examples, or references that could aid in understanding your requirements.

8. Acknowledge Terms:

• By submitting a request, you acknowledge that:

• The service is limited, and support may be discontinued at any time.

• Response times are not guaranteed.

• The Shelly team may prioritize other requests based on workload and feasibility.

 

Request Submission Template

 

1. Script Description:

[Clearly explain the script’s purpose and functionality.]

 

2. Target Device(s):

[List the Shelly device(s) this script is for.]

 

3. Inputs and Outputs:

• Inputs: [List inputs the script will handle.]

• Outputs: [List expected results or actions.]

 

4. Third-Party Integration:

• Required Protocol/API: [Yes/No]

• Documentation or Link: [Attach/upload file or provide link.]

 

5. Additional Features:

[List any additional features or requirements.]

 

6. Known Constraints:

[Describe any constraints or limitations.]

 

7. Existing Code or Examples (Optional):

[Attach/upload file or paste code snippet.]

 

Important Notes:

• Requests missing required documentation for 3rd-party integrations may be delayed or rejected.

• Submissions should be as detailed as possible to avoid unnecessary delays.