Jump to content

Template:Boilerplate-UserGuide: Difference between revisions

From SOJI ELECTRONICS
[checked revision][checked revision]
← Older edit
Admin (talk | contribs)
Bureaucrats, Interface administrators, Administrators
1,203 edits
VisualWikitext
No edit summary
Update
 
(14 intermediate revisions by the same user not shown)
Line 2: Line 2:
This boilerplate creates a User Guide page structure following IEC/IEEE 82079-1.
This boilerplate creates a User Guide page structure following IEC/IEEE 82079-1.


11 sections:
11 mandatory sections (== H2 ==):
# Safety Information
# Safety Information
# Product Overview
# Product Overview
Line 16: Line 16:


[[Category:Boilerplates]]
[[Category:Boilerplates]]
</noinclude><includeonly>
</noinclude><includeonly>== Safety Information ==
== Safety Information ==
<div class="dim">


''Read this section completely before installation or operation. Failure to observe these warnings may result in serious injury, death, or damage to equipment.''
''This section documents all safety-related information per IEC/IEEE 82079-1 and ANSI Z535.6 standards.''


=== General Safety ===
'''What to fill in:'''
* General safety requirements (PPE, qualified personnel, working conditions)
* Specific hazards using callouts:
** <code><nowiki>{{Danger|title=...|body=...}}</nowiki></code> — imminent hazard, death/serious injury
** <code><nowiki>{{Warning|title=...|body=...}}</nowiki></code> — potential hazard, possible injury
** <code><nowiki>{{Caution|title=...|body=...}}</nowiki></code> — potential equipment damage
** <code><nowiki>{{Notice|title=...|body=...}}</nowiki></code> — important info, no hazard
* Emergency procedures (fire, electric shock, chemical exposure, evacuation)
* Emergency contact numbers


{{Placeholder|e.g., Describe required PPE (safety goggles, gloves), qualified personnel (electrician, technician), and working conditions (well-ventilated, dry, no ignition sources).}}
'''Example callout:'''
{{Notice|title=Sample Notice|body=Read entire guide before installation. Qualified technicians only. Wear PPE.}}


=== Specific Hazards ===
</div>
 
{{Notice
| title = General Operating Conditions
| body  = * Read the entire User Guide before installation
* Installation by qualified technicians only
* Wear appropriate Personal Protective Equipment (PPE)
}}
 
{{Placeholder|e.g., Add specific hazard callouts here using {{Danger}}, {{Warning}}, {{Caution}}, {{Notice}} templates. For each hazard: describe the hazard, consequence, and how to avoid.}}
 
=== Emergency Procedures ===
 
{{Placeholder|e.g., Describe what to do in case of fire, electric shock, chemical exposure, or other product-specific emergencies. Include emergency contact numbers.}}


== Product Overview ==
== Product Overview ==
<div class="dim">


{{Placeholder|e.g., The [Product Name] is a [type] device designed for [primary application]. It features [key technology] and is built for [target environment]. Brief 1–2 paragraph overview of what the product is, what it does, and its key value.}}
''Introduce the product: what it is, what it does, and key value proposition.''


=== Intended Use ===
'''What to fill in:'''
* 1–2 paragraph product description: name, category, primary function, key features
* '''Intended Use''' — bullet list of applications the product is designed for
* '''NOT Intended For''' — bullet list of excluded applications (safety/regulatory)
* '''Product Variants''' — table of variants if multiple SKUs exist (Variant / Description / Use Case)


The product is intended for:
'''Example structure:'''
* {{Placeholder|e.g., Fuel level monitoring in commercial trucks and fleet vehicles}}
* Paragraph: "The [Product Name] is a [type] device designed for [primary application]..."
* {{Placeholder|e.g., Backup generator fuel monitoring at telecom sites}}
* Variants table with columns: Variant | Description | Use Case
* {{Placeholder|e.g., Industrial tank monitoring in stationary applications}}


=== NOT Intended For ===
</div>


The product is '''not''' intended for:
== Package Contents ==
* {{Placeholder|e.g., Use in hazardous/explosive atmospheres (use ATEX-rated variant instead)}}
<div class="dim">
* {{Placeholder|e.g., Submerged or pressurized fluid applications above IP rating}}
 
=== Product Variants ===
 
{| class="wikitable"
! Variant !! Description !! Use Case
|-
| {{Placeholder|e.g., Standard}} || {{Placeholder|e.g., Cabled version with 2m cable}} || {{Placeholder|e.g., Truck fuel tanks}}
|-
| {{Placeholder|e.g., Extended}} || {{Placeholder|e.g., Cabled version with 5m cable}} || {{Placeholder|e.g., Industrial tanks}}
|}


== Package Contents ==
''List everything included in the shipment box.''


Each shipment includes:
'''What to fill in:''' table with columns:
* '''No.''' — item number (1, 2, 3, ...)
* '''Item''' — item name (vd: "Main sensor unit", "Mounting bracket", "Connection cable 2m")
* '''Quantity''' — quantity per package (vd: 01, 02)


{| class="wikitable"
'''Important note to include:''' "Verify all items are present before installation. Contact support if any item is missing or damaged."
! No. !! Item !! Quantity
|-
| 1 || {{Placeholder|e.g., Main sensor unit}} || 01
|-
| 2 || {{Placeholder|e.g., Mounting bracket kit}} || 01
|-
| 3 || {{Placeholder|e.g., Connection cable (2m)}} || 01
|-
| 4 || Quick installation guide || 01
|}


'''Verify all items are present before installation.''' Contact support if any item is missing or damaged.
</div>


== Specifications ==
== Specifications ==
<div class="dim">


=== Technical Specifications ===
''Technical specifications of the product per IEC/IEEE 82079-1.''
 
{| class="wikitable" style="text-align:center;"
! Parameter !! Value !! Unit
|-
| style="text-align:left;" | Dimensions (L × W × H) || {{Placeholder|e.g., 120 × 80 × 35}} || mm
|-
| style="text-align:left;" | Weight || {{Placeholder|e.g., 250}} || g
|-
| style="text-align:left;" | Operating temperature || {{Placeholder|e.g., −40 to +85}} || °C
|-
| style="text-align:left;" | Storage temperature || {{Placeholder|e.g., −40 to +85}} || °C
|-
| style="text-align:left;" | Power supply || {{Placeholder|e.g., 9–32 VDC}} || V
|-
| style="text-align:left;" | Current consumption || {{Placeholder|e.g., 25 (avg) / 80 (peak)}} || mA
|-
| style="text-align:left;" | Wireless protocol || {{Placeholder|e.g., Bluetooth 5.0 LE}} || —
|-
| style="text-align:left;" | Ingress protection || {{Placeholder|e.g., IP67}} || IP rating
|-
| style="text-align:left;" | Service life (expected) || {{Placeholder|e.g., 5}} || years
|}


=== Dimensions ===
'''What to fill in:''' specification table with columns Parameter / Value / Unit, covering:
* Mechanical: Dimensions (L × W × H), Weight
* Environmental: Operating temperature, Storage temperature, Ingress protection (IP)
* Electrical: Power supply, Current consumption (avg/peak/sleep)
* Wireless (if applicable): Bluetooth/WiFi/LoRa protocol
* Service life (expected years)


[[File:Product-dimensions.png|thumb|center|500px|Overall dimensions (mm)]]
'''Sub-sections to consider:'''
* '''Technical Specifications''' — main spec table
* '''Dimensions''' — mechanical drawing image (upload as "Product-dimensions.png")
* '''Pinout/Connector''' (if applicable)


{{Placeholder|e.g., Upload your product dimension drawing as "Product-dimensions.png" via Special:Upload, or replace the File: link above with your actual filename.}}
</div>


== Installation ==
== Installation ==
<div class="dim">


'''Before installation''': Read [[#Safety Information|Safety Information]] section.
''Step-by-step installation procedure.''
 
=== Tools Required ===


* {{Placeholder|e.g., Phillips screwdriver (PH2)}}
'''Pre-requisite:''' "Before installation: Read [[#Safety Information|Safety Information]] section."
* {{Placeholder|e.g., Adjustable wrench / 13mm spanner}}
* Personal Protective Equipment (PPE): safety goggles, gloves


=== Step 1: Site Preparation ===
'''What to fill in (sub-sections):'''
* '''Tools Required''' — bullet list of tools + PPE
* '''Step 1: Site Preparation''' — clean mounting surface, clearance, power off
* '''Step 2: Mounting''' — physical mounting procedure with torque values
* '''Step 3: Connection''' — electrical/wireless connection with wire color codes
* '''Step 4: Verification''' — how to verify installation (LED status, app discovery)


{{Placeholder|e.g., Clean the mounting surface. Verify location meets minimum clearance (10 cm around device). Ensure power source is disconnected before starting work.}}
'''Optional:''' mounting diagram image (upload as "Product-mounting.png")


=== Step 2: Mounting ===
</div>
 
{{Placeholder|e.g., Drill 4 mounting holes per the included template. Use M5 bolts to secure the device. Recommended torque: 2.5 N·m.}}
 
[[File:Product-mounting.png|thumb|center|500px|Mounting diagram]]
 
=== Step 3: Connection ===
 
{{Placeholder|e.g., Connect red wire to +12V, black to GND. For RS485: yellow to A+, green to B−. Verify polarity before powering on.}}
 
=== Step 4: Verification ===
 
{{Placeholder|e.g., Apply power. LED should turn green within 5 seconds. Use mobile app to confirm device is discoverable via Bluetooth. Test measurement output.}}


== Configuration ==
== Configuration ==
<div class="dim">


{{Placeholder|e.g., This section describes how to configure the product after physical installation. Configuration is done via mobile app (iOS/Android) or USB tool.}}
''Software setup after physical installation.''
 
=== Mobile Application ===
 
Download mobile app:
* '''iOS''': App Store — {{Placeholder|e.g., [https://apps.apple.com/... SOJI Tool on App Store]}}
* '''Android''': Google Play — {{Placeholder|e.g., [https://play.google.com/... SOJI Tool on Google Play]}}
 
'''Note''': Grant all permissions requested by the app (Camera, Location, Nearby devices, Bluetooth).
 
=== Connecting Sensor ===
 
# Open the application
# Select product from list
# Wait for device to appear in discovered list
# Press '''Connect'''
 
=== Calibration ===
 
{{Placeholder|e.g., Calibration ensures the device reads accurate values. Perform calibration during initial setup and after any major maintenance.}}
 
==== Step 1: Set Full ====
 
# {{Placeholder|e.g., Fill tank to maximum level}}
# {{Placeholder|e.g., In app: Settings → Calibration → tap "Set Full"}}
# {{Placeholder|e.g., Wait 30 seconds for reading to stabilize, confirm value}}
 
==== Step 2: Set Empty ====
 
# {{Placeholder|e.g., Drain tank to minimum level}}
# {{Placeholder|e.g., In app: Settings → Calibration → tap "Set Empty"}}
# {{Placeholder|e.g., Confirm value when reading stabilizes}}


=== Configurable Parameters ===
'''What to fill in (sub-sections):'''
* '''Mobile Application''' — iOS/Android app download links + required permissions
* '''Connecting Sensor''' — numbered steps to discover and pair device
* '''Calibration''' — calibration procedure (Set Full, Set Empty, etc.)
* '''Configurable Parameters''' — table with columns: Parameter / Default / Range / Description
** Common params: Device name, Measurement interval, Output protocol, Password


{| class="wikitable"
</div>
! Parameter !! Default !! Range / Options !! Description
|-
| Device name || {{Placeholder|e.g., LIGO-AIR-001}} || {{Placeholder|e.g., Max 20 chars}} || {{Placeholder|e.g., Bluetooth advertised name}}
|-
| Measurement interval || {{Placeholder|e.g., 60 s}} || {{Placeholder|e.g., 1–3600 s}} || {{Placeholder|e.g., How often device measures and broadcasts}}
|-
| Output protocol || {{Placeholder|e.g., BLE}} || {{Placeholder|e.g., BLE / RS485 / 4–20 mA}} || {{Placeholder|e.g., Communication output format}}
|-
| Password || (default) || {{Placeholder|e.g., 6–20 chars}} || '''Must change before deployment'''
|}


== Operation ==
== Operation ==
<div class="dim">


{{Placeholder|e.g., Day-to-day usage instructions. How operators interact with the product during normal operation.}}
''Day-to-day usage instructions for end users.''


=== Calibration Table ===
'''What to fill in (sub-sections):'''
* '''Reading Data''' — how data is delivered (gateway, app, cloud)
* '''Calibration Methods''' — table of available calibration methods with recommended option
* '''Long-Range Operation''' — range settings for challenging environments
* '''Protective Accessories''' — optional caps/housings if applicable
* '''Operating Modes''' — normal/diagnostic/sleep modes if applicable


The product supports calibration in two ways:
</div>


{| class="wikitable"
== Troubleshooting ==
! Method !! Description !! Recommended
<div class="dim">
|-
| {{Placeholder|e.g., Method 1 (Platform)}} || {{Placeholder|e.g., Calibrate via cloud platform with multi-point reference}} || ✓
|-
| {{Placeholder|e.g., Method 2 (On Device)}} || {{Placeholder|e.g., Calibrate directly on device using buttons}} ||
|}
 
=== Reading Data ===
 
Data can be received by:
* Telematics device / Gateway
* Smartphone with mobile app
 
{{Placeholder|e.g., For detailed protocol integration, see [[Product Configuration]].}}
 
=== Long-Range Operation ===
 
For challenging environments (long distance, metal obstacles):
 
{| class="wikitable"
! Combination !! Range
|-
| {{Placeholder|e.g., Standard setup}} || {{Placeholder|e.g., Up to 50m line-of-sight}}
|-
| {{Placeholder|e.g., With high-gain antenna accessory}} || {{Placeholder|e.g., Up to 100m line-of-sight}}
|}
 
=== Protective Cover ===


{{Placeholder|e.g., If using the optional protective cap/housing (P/N XXX), install per the accessory manual. The cap provides additional protection against UV exposure and physical impact.}}
''Common problems and solutions for end users.''


== Troubleshooting ==
'''What to fill in:''' table with columns:
* '''Symptom''' — what user observes (vd: "Device does not power on", "No Bluetooth connection")
* '''Possible Cause''' — bullet list of potential causes
* '''Solution''' — bullet list of step-by-step solutions


{| class="wikitable"
'''Closing note:''' "If problem persists, contact [[#Support / Contact|Support]]."
! Symptom !! Possible Cause !! Solution
|-
| {{Placeholder|e.g., Device does not power on}}
|
* {{Placeholder|e.g., No power supply}}
* {{Placeholder|e.g., Reverse polarity wiring}}
|
* {{Placeholder|e.g., Verify voltage with multimeter (9–32 VDC required)}}
* {{Placeholder|e.g., Check wire colors per Installation Step 3}}
|-
| {{Placeholder|e.g., No Bluetooth connection}}
|
* {{Placeholder|e.g., Device out of range}}
* {{Placeholder|e.g., Bluetooth disabled on phone}}
|
* {{Placeholder|e.g., Move closer (<10 m)}}
* {{Placeholder|e.g., Enable Bluetooth + Location permissions}}
|-
| {{Placeholder|e.g., Incorrect readings}}
|
* {{Placeholder|e.g., Calibration drift over time}}
|
* {{Placeholder|e.g., Re-run calibration procedure}}
|}


''If problem persists, contact [[#Support / Contact|Support]].''
</div>


== Maintenance ==
== Maintenance ==
<div class="dim">


=== Periodic Inspection ===
''Periodic maintenance and end-of-life procedures.''
 
{| class="wikitable"
! Frequency !! Action
|-
| Monthly          || {{Placeholder|e.g., Visual inspection for physical damage, check mounting torque}}
|-
| Quarterly        || {{Placeholder|e.g., Clean external surface, verify LED indicator}}
|-
| Annually        || {{Placeholder|e.g., Verify calibration with reference, check cable integrity}}
|-
| Every 5 years    || {{Placeholder|e.g., Full functional test, re-calibrate}}
|-
| Every 8–10 years || {{Placeholder|e.g., Battery replacement (if battery-powered)}}
|}


=== Cleaning ===
'''What to fill in (sub-sections):'''
* '''Periodic Inspection''' — table: Frequency (Monthly/Quarterly/Annually/5-year/8-10 year) / Action
* '''Cleaning''' — procedure with prohibited materials (solvents, abrasives)
* '''Battery Replacement''' (if applicable) — procedure + safety warnings
* '''Calibration Verification''' — re-calibration after maintenance
* '''Disposal / End-of-Life''' — recycling instructions per WEEE/RoHS


# Disconnect product from system
'''Required safety callout:'''
# Wipe external surface with dry cloth or non-conductive cleaner
{{Warning|title=Battery Replacement Safety|body=Replace only with authorized part. Disconnect before opening. Wear chemical-resistant gloves. Observe correct polarity.}}
# Do '''NOT''' use:
#* Solvents (acetone, benzene)
#* Abrasive materials
#* High-pressure water beyond IP rating


=== Battery Replacement ===
</div>
 
{{Placeholder|e.g., If battery-powered: describe battery replacement procedure. Include battery part number, replacement interval, and required torque for housing screws.}}
 
{{Warning
| title = Battery Replacement Safety
| body  = * Replace only with authorized battery part
* Disconnect from system before opening
* Wear chemical-resistant gloves
* Observe correct polarity
}}
 
=== Calibration Verification ===
 
After maintenance, re-perform calibration (see [[#Configuration|Configuration]]).
 
=== Disposal / End-of-Life ===
 
* Remove battery and dispose separately at certified battery recycling facility
* Send product body to electronic waste recycling
* Do '''NOT''' dispose in regular trash
* In EU: Take-back via local WEEE registration scheme


== Certification / Compliance ==
== Certification / Compliance ==
<div class="dim">


=== Wireless / Radio ===
''Regulatory certifications and standards compliance.''
 
{| class="wikitable"
! Region !! Standard !! Status
|-
| EU      || RED 2014/53/EU, EMC 2014/30/EU || Compliant
|-
| US      || FCC Part 15 || Compliant
|-
| Canada  || ISED RSS || Compliant
|-
| UK      || UKCA, UK RED || Compliant
|}


=== Environmental ===
'''What to fill in (sub-sections with tables):'''
* '''Wireless / Radio''' — Region / Standard / Status (CE RED, FCC Part 15, ISED RSS, UKCA)
* '''Environmental''' — Standard / Status (RoHS 3, REACH, WEEE, Battery WEEE)
* '''Mechanical''' — Standard / Rating (IEC 60529 IP rating)
* '''Bluetooth Qualification''' (if applicable) — QDID, SIG Member ID, EPDID
* '''Warranty''' — period, exclusions, void conditions


{| class="wikitable"
'''Cross-references:'''
! Standard !! Status
* See [[Product Certification & Approvals]] for detailed certificates
|-
* See [[Product Memberships]] for SIG memberships
| RoHS 3 (2011/65/EU + 2015/863) || Compliant
|-
| REACH (EC 1907/2006)          || Compliant
|-
| WEEE (2012/19/EU)              || Registered
|-
| Battery WEEE (2006/66/EC)      || {{Placeholder|e.g., Registered (if applicable)}}
|}


=== Mechanical ===
</div>
 
{| class="wikitable"
! Standard !! Rating
|-
| IEC 60529 (Ingress Protection) || {{Placeholder|e.g., IP67}}
|}
 
=== Bluetooth Qualification ===
 
{{Placeholder|e.g., If product uses Bluetooth, list QDID, Member ID, and EPDID below. Remove this section if not applicable.}}
 
* Bluetooth Core Specification: {{Placeholder|e.g., 5.0}}
* Bluetooth SIG Member ID: {{Placeholder|e.g., see [[Product Memberships]]}}
* End Product Declaration ID: {{Placeholder|e.g., D012345}}
 
''Detailed certification information: see [[Product Certification & Approvals]]''
''Memberships information: see [[Product Memberships]]''
 
=== Warranty ===
 
* '''Warranty period''': {{Placeholder|e.g., 2}} years from date of shipment
* '''NOT covered''': battery, physical damage, unauthorized modification
* '''Warranty void if''':
** Operating conditions exceed specifications
** Unauthorized modification or repair
** Damage from improper installation
** Damage from chemical exposure outside rated fluids


== Support / Contact ==
== Support / Contact ==
<div class="dim">


{| class="wikitable"
''Customer support channels.''
! Channel !! Contact
|-
| Website || [https://sojielectronics.com sojielectronics.com]
|-
| Email  || support@sojielectronics.com
|-
| Phone  || {{Placeholder|e.g., +84 ... (insert support number)}}
|-
| Address || {{Placeholder|e.g., SOJI Electronics JSC, [insert full address]}}
|}
 
=== Documentation ===
 
{| class="wikitable"
! Document !! Version !! Last Updated
|-
| This User Guide || 1.0 || {{subst:#time:d/m/Y}}
|-
| Datasheet || {{Placeholder|e.g., 1.2}} || {{Placeholder|e.g., 01/05/2026}}
|-
| Configuration Guide || {{Placeholder|e.g., 1.0}} || {{Placeholder|e.g., 15/04/2026}}
|-
| Protocol Integration || {{Placeholder|e.g., 1.1}} || {{Placeholder|e.g., 20/04/2026}}
|}
 
=== Related Pages ===


* [[Product Datasheet]]
'''What to fill in:''' contact table with rows:
* [[Product Certification & Approvals]]
* '''Website''' — sojielectronics.com
* [[Frequently Asked Questions - FAQ]]
* '''Email''' — support@sojielectronics.com
* '''Phone''' — support number
* '''Address''' — full company address
* '''Service hours''' — vd: "Mon–Fri, 08:00–17:00 GMT+7"


=== Revision History ===
</div>
<div class="noprint">
== Related Documents ==
''Cross-references to other documents.''
{{RelatedDocuments}}
</div>


{| class="wikitable"
== Revision History ==
! Date !! Version !! Description
<div class="revision-history-auto">
|-
<span class="dim">Loading revision history...</span>
| {{subst:#time:d/m/Y}} || 1.0 || Initial release
</div>
|}


{{Placeholder|Add product category below. Examples: [[Category:LIGO AIR]], [[Category:LIGO PRO]], [[Category:LIGO PRO BLE]],.... The page will appear under that product in CategoryTree and sidebar. Delete this hint after replacing the category line.}}
[[Category:{{subst:#replace:{{subst:PAGENAME}}| User Guide|}}]]
[[Category:Main Page]]
</includeonly>
</includeonly>

Latest revision as of 09:01, 25 May 2026

This boilerplate creates a User Guide page structure following IEC/IEEE 82079-1.

11 mandatory sections (== H2 ==):

  1. Safety Information
  2. Product Overview
  3. Package Contents
  4. Specifications
  5. Installation
  6. Configuration
  7. Operation
  8. Troubleshooting
  9. Maintenance
  10. Certification / Compliance
  11. Support / Contact
SOJI Electronics
Retrieved from "https://wiki.sojielectronics.com/index.php?title=Template:Boilerplate-UserGuide&oldid=1229"