E-Sharp Helpcenter
Breadcrumbs

Firmware

Firmware Management

Overview

The Firmware Management features allow you to view current firmware information, update Accordion device firmware, and control system services. These operations are critical for maintaining device functionality and deploying updates.

Accessing Firmware Features

Ribbon → Tools → Shell → Select firmware operations

Firmware Information

View Current Version

Information Displayed:

  • Current FW: Installed firmware version

  • Network Configuration: Device network interfaces

  • IP Address: Current device IP

  • MAC Address: Hardware address

Firmware Updates

Update Process

Standard Update:

Process Steps:

  1. Connects to device via SSH

  2. Downloads firmware from repository

  3. Stops Accordion service

  4. Installs new firmware

  5. Starts Accordion service

  6. Verifies new version

Duration: Typically 30 seconds to 2 minutes depending on firmware size and network speed.

Custom Repository

Use alternative firmware source:

Bash
AccordionShell firmware --host 192.168.1.100 --repo "https://custom-server.com/firmware" --version "v3.0.0"

Default Repository:

https://esharp.blob.core.windows.net/accfirmware

Service Control

Stop Accordion Service

Stop the Accordion service:

Bash
AccordionShell firmware --host 192.168.1.100 --stop

Use Cases:

  • Prepare for firmware update

  • Perform maintenance

  • Restart service after configuration change

  • Troubleshooting

⚠️ Warning: Stopping service disconnects all clients and disables hardware access.

Start Accordion Service

Start the Accordion service:

Use Cases:

  • After firmware update

  • After maintenance

  • Restart after stop

  • Recovery from service crash

Service Restart

Restart service (stop then start):

SSH Connection Management

SSH Sessions

Firmware operations use SSH to communicate with the Accordion device.

Connection Behavior:

  • First firmware command establishes SSH connection

  • Connection persists for subsequent commands

  • Reuses connection for efficiency

During Update

While updating:

  1. Do NOT interrupt:

    • Don't power off device

    • Don't disconnect network

    • Don't close terminal

    • Wait for completion

  2. Monitor Progress:

    • Watch console output

    • Note any errors

    • Be ready to troubleshoot

  3. Be Patient:

    • Updates take time (30s - 2min)

    • Progress may pause briefly

    • Don't assume it's stuck

Post-Update Verification

After update:

  1. Verify Version:
    Confirm version matches expected

  2. Test Connectivity:

    • Reconnect Accordion Pilot

    • Verify channel list loads

    • Test basic channel operations

  3. Verify Functionality:

    • Test critical features

    • Check all modules load

    • Verify aliases work

    • Test bus communications

  4. Check Logs:

    • Review application logs

    • Check for warnings/errors

    • Verify services started

  5. Performance Check:

    • Test response time

    • Verify polling works

    • Check transaction logging

Rollback

If update fails or causes issues:

  1. Rollback to previous version:

  2. Restore configuration:

    • Upload previous alias files

    • Reload modules

    • Restore settings

  3. Report Issue:

    • Document the problem

    • Capture error logs

    • Contact E-Sharp support

Firmware Versions

Version Numbering

Format: vX.Y.Z

  • X (Major): Major release, may include breaking changes

  • Y (Minor): New features, backward compatible

  • Z (Patch): Bug fixes, no new features

Examples:

  • v2.5.1: Version 2, minor release 5, patch 1

  • v3.0.0: Version 3, major release

Release Channels

  • Stable: Tested, production-ready releases

  • Beta: Preview of upcoming features

  • Development: Cutting-edge, may be unstable

Choose appropriate channel for your use case:

  • Production: Use stable releases only

  • Testing/Development: Beta or development OK

  • Critical Systems: Stay on proven stable version

Troubleshooting Firmware Updates

Update Fails

Problem: Firmware update doesn't complete

Solutions:

  1. Check Network:

    • Verify device reachable

    • Test SSH connection manually

    • Check firewall rules

  2. Verify Repository:

    • Confirm repository URL accessible

    • Try default repository

    • Check internet connection

  3. Service State:

    • Ensure service can be stopped

    • Check no processes holding resources

    • Try manual service stop first

  4. Disk Space:

    • Verify device has space for firmware

    • Clean up old files if needed

  5. Try Again:

    • Sometimes transient network issues

    • Disconnect SSH and retry

    • Restart device and retry

Cannot Connect for Update

Problem: SSH connection fails

Solutions:

  1. Verify Device Online:

    • Ping device IP

    • Check physical connection

    • Verify device powered on

  2. SSH Service Running:

    • SSH should be enabled by default

    • Check with IT if SSH blocked

  3. Credentials:

    • Default credentials should work

    • Check with E-Sharp if issues

  4. Network Configuration:

    • Verify IP address correct

    • Check subnet/gateway

    • Try from different computer

Version Mismatch After Update

Problem: Version doesn't change after update

Solutions:

  1. Verify Update Completed:

    • Check all progress messages

    • Look for errors during update

    • Check service restarted

  2. Cache Issue:

    • Disconnect and reconnect

    • Restart Accordion Pilot

    • Clear browser cache if using web interface

  3. Actual Update Failed:

    • Check logs on device

    • Retry update

    • Contact support

Best Practices

  1. Test in Development First: Always test firmware updates in non-production environment

  2. Schedule Updates: Plan firmware updates during maintenance windows

  3. Backup First: Always backup configuration before updating

  4. Document Version: Keep record of firmware versions deployed

  5. Verify After Update: Always test functionality after update

  6. Keep Updated: Stay reasonably current with firmware releases

  7. Read Release Notes: Review changes before updating

  8. Have Rollback Plan: Know how to rollback if needed

Safety and Reliability

⚠️ Important Safety Notes:

  1. Don't Interrupt Updates: Can brick device

  2. Stable Power: Ensure device has stable power during update

  3. Stable Network: Ensure reliable network connection

  4. Backup Critical Systems: Have spare device for critical applications

  5. Test First: Always test updates in safe environment